auto_ria_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82fb4b202b4c2d3edc4257ba2dcb5f8585cd35604651695cb765d8dddfa0c129
-  data.tar.gz: 02a2b30dc955f38ffef0850c5236d27bc4a0985418eddd8de1ed7ecf8372c9a5
+  metadata.gz: 5ad52d92d1b42ebfe2298c8c65d6e1860f88c6ad794fa8fc51dadf2de730422a
+  data.tar.gz: 92653049945c86cacf4ea14f83de2d6897d7aaf70663f44fb4d4d67dd31fb480
 SHA512:
-  metadata.gz: 41761f22f13c17848022eaba0140b0b8e4e998af840e3809f73356e339195ccf4b4aa8bb7d6faf5a76000202304fe3f5e83582c0a0d2bbceb5ecd03995e16a31
-  data.tar.gz: '0691a1061b25b5fcdec895daebc778011c8513849d8e2a5094e9ca69173051bc1158e74b65fdc2f964f61e1a92f47469020634622a008fed75413a56b67b824d'
+  metadata.gz: c55d7cda985ce3ec8b7a2086a55ec4ba9c50699f09bed831dc0384f63dcf4ed947306f037ad5b47f5beb13a5708b2f0e475cdd360cbe53eccee7a718d5aab8b5
+  data.tar.gz: 4037cbeb2ba4f3c93dd2379e149f5f98f4530118d9dd2e5bb4e5d6be5075dd260210110c1102fb929d4b43941e8cc4268c9437d2196f08dce115d4f3a1aa1e8a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    auto_ria_api (0.1.0)
+    auto_ria_api (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,8 @@
-# AutoRiaApi
+# Auto Ria Api
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/auto_ria_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem provides integration with [https://auto.ria.com/](https://auto.ria.com/)
 
-TODO: Delete this and the text above, and describe your gem
+#### Please NOTE that this is very early version and not all endpoints are implemented.
 
 ## Installation
 
@@ -21,18 +21,45 @@ Or install it yourself as:
     $ gem install auto_ria_api
 
 ## Usage
+First of all you need an api_key which you can get at [https://developers.ria.com](https://developers.ria.com)
+```ruby
+# create an instance 
+@client = AutoRiaApi::Base.new(api_key: ENV['AUTO_RIA_API_KEY'])
+
+# Methods:
+@clien.types
+@clien.carcasses(type, grouped: false, all: false)
+@clien.marks(carcasse)
+@clien.models(carcasse, mark, grouped: false, all: false)
+@clien.regions
+@clien.cities(region)
+@clien.gearboxes(carcasse)
+@clien.fuels
+@clien.colors
+@clien.options(carcasse)
+# all method arguments assuming ID (Integer)
 
-TODO: Write usage instructions here
+```
+For more detailed documentation follows: 
 
-## Development
+[https://github.com/ria-com/auto-ria-rest-api/tree/master/AUTO_RIA_API](https://github.com/ria-com/auto-ria-rest-api/tree/master/AUTO_RIA_API)
 
-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.
+[https://api-docs-v2.readthedocs.io/ru/latest/auto_ria/index.html](https://api-docs-v2.readthedocs.io/ru/latest/auto_ria/index.html)
 
-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](https://rubygems.org).
+## TODO:
+1. Get rid of ::Base namespace. I.e instance should be created directly with `AutoRiaApi.new` 
+1. Implement `search` 
+1. Implement `average_price` 
+1. Implement `info`  endpoints
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/auto_ria_api.
+Bug reports and pull requests are welcome on GitHub at https://github.com/drkmen/auto_ria_api. 
+Help is appreciated Feel free to fork and make a difference!
+
+## Tests
+
+Provide `ENV['AUTO_RIA_API_KEY']` in your `.env` file or add it to system env: `export AUTO_RIA_API_KEY=your_key` and run `rspec` 
 
 ## License
 

data/lib/auto_ria_api.rb

@@ -14,19 +14,19 @@ module AutoRiaApi
       request '/auto/categories'
     end
 
-    def carcasses(type, grouped: false, all: false)
+    def carcasses(type:, grouped: false, all: false)
       raise ArgumentError, 'Type should not be empty.' if blank?(type)
       return request '/auto/bodystyles' if all
       group = '_group' if grouped
       request "/auto/categories/#{type}/bodystyles/#{group}"
     end
 
-    def marks(carcasse)
+    def marks(carcasse:)
       raise ArgumentError, 'Carcass should not be empty.' if blank?(carcasse)
       request "/auto/categories/#{carcasse}/marks"
     end
 
-    def models(carcasse, mark, grouped: false, all: false)
+    def models(carcasse:, mark:, grouped: false, all: false)
       raise ArgumentError, 'Carcass should not be empty.' if blank?(carcasse)
       raise ArgumentError, 'Mark should not be empty.' if blank?(mark)
       return request '/auto/models' if all
@@ -38,12 +38,12 @@ module AutoRiaApi
       request '/auto/states'
     end
 
-    def cities(region)
+    def cities(region:)
       raise ArgumentError, 'Region should not be empty.' if blank?(region)
       request "/auto/states/#{region}/cities"
     end
 
-    def gearboxes(carcasse)
+    def gearboxes(carcasse:)
       raise ArgumentError, 'Carcasse should not be empty.' if blank?(carcasse)
       request "/auto/categories/#{carcasse}/gearboxes"
     end
@@ -60,7 +60,7 @@ module AutoRiaApi
       request '/auto/colors'
     end
 
-    def options(carcasse)
+    def options(carcasse:)
       raise ArgumentError, 'Carcasse should not be empty.' if blank?(carcasse)
       request "/auto/categories/#{carcasse}/auto_options"
     end
@@ -73,13 +73,14 @@ module AutoRiaApi
       raise 'Not implemented'
     end
 
-    def info(*args)
-      raise 'Not implemented'
+    def info(car_id:)
+      raise ArgumentError, 'car_id should not be empty.' if blank?(car_id)
+      request '/auto/info', auto_id: car_id
     end
 
     private
 
-    def request(url, method = :get_response, params = {})
+    def request(url, params = {}, method = :get_response)
       uri = URI(@default_url + url)
       uri.query = URI.encode_www_form(params.merge(api_key: @api_key))
       response = Net::HTTP.public_send(method, uri)

data/lib/auto_ria_api/version.rb

@@ -1,3 +1,3 @@
 module AutoRiaApi
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auto_ria_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - drkmen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler