0.0
No commit activity in last 3 years
No release in over 3 years
Simple API REST client for allegro.pl
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.16
~> 0.10.4
~> 10.0
~> 3.0

Runtime

~> 1.8.3
 Project Readme

Gem Version Build Status

Allegro API

Simple Ruby REST API client for Allegro API for device flow.

https://developer.allegro.pl/about/#rest-api https://developer.allegro.pl/swagger.yaml

Installation

Add this line to your application's Gemfile:

gem 'allegro-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install allegro-api

Usage

# Create client instance and authorize
api = Allegro::Client.new('client','secret')

# Does client authorized sucessfully?
api.authorized? # => false

# Search for some offers with some parameters
api.search({ 'seller.id' => '1'}) # { 'items' => [ ... ] } JSON response dumped to Hash

TODO

  • Write specs!
  • Enable specs on travis!
  • Add possibilty to setup/change api version
  • Handle more Http::Agent methods and/or move agent to sepearate gem
  • Prepare some method for searching offers
  • Prepare some methods for other API methods
  • Add more TODO-s

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kmi3c/allegro-api.