skroutz 0.1.0

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rspec
+.ruby-gemset
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tags
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  Exclude:
+    - 'Guardfile'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%w": "[]"
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SpaceInsideBlockBraces:
+  EnforcedStyleForEmptyBraces: space
+
+Style/Blocks:
+  Exclude:
+    - spec/**/*.rb
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+---
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - 2.2.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-2
+  fast_finish: true
+script: bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - 2015-03-29
+
+### Added
+
+* Associations. [Read More](https://github.com/skroutz/skroutz.rb#associations)
+* Favorite Lists. User favorite lists can be fetched  
+  Example:
+  ```ruby
+  client = Skroutz::Client.new('', '')
+  client.user_token = 'a valid user token'
+  client.favorite_lists.all
+  ```
+* Skroutz::Client#user_token and Skroutz::Client#user_token=
+* Reviews. The reviews of a SKU can be fetched  
+  Example:
+  ```ruby
+  client.skus(42).reviews
+  ```
+* Specifications. The specifications of a SKU can be fetched  
+  Example:
+  ```ruby
+  client.skus(42).specifications
+  ```
+* Locations. The locations of a Shop can be fetched  
+  Example: 
+  ```ruby
+  client.shops(42).locations # GET /shops/42/locations
+  ```
+* Rate-limiting error handling, when a request fails due to
+  rate-limiting, `Skroutz::RateLimitingError` is raised
+* For all methods which perform a request, the HTTP verb can be
+  specified using either the `:verb`, or `:via` options  
+  Example: 
+  ```ruby
+  client.categories.all(via: :post) # POST /categories
+  ```
+* Direct association requests. Intermediate requests for nested
+  resources can be avoided  
+  Example: 
+  ```ruby
+  client.categories(42).skus # Performs 1 request to /categories/42/sks
+  ```
+* `Skroutz::Client#autocomplete`
+* AR-like resource inspection using `Skroutz::Resource#inspect`
+* All collections respond to `#meta` with contains response metadata
+
+### Changed
+
+* Direct instantiation of abstract class `Skroutz::CollectionProxy` raises `RuntimeError`
+* Responses with status 401 Unauthorized raise `Skroutz::UnauthorizedError`
+* Responses with status 400 Bad Request raise `Skroutz::ClientError`
+* Resource attribute predicate methods always return boolean values
+  Example:
+  ```ruby
+  client.skus.find(42).virtual? # => false
+  ```
+* The name of the gem to `skroutz` from `skroutz_api` and the namespace to `Skroutz` from `SkroutzApi` accordingly
+* `Skroutz::PaginatedCollection#is_at_last_page?` is renamed to `#last_page?`
+* `Skroutz::PaginatedCollection#is_at_first_page?` is renamed to `#first_page?`
+* Trying to fetch a non-existant page returns nil instead of empty Array
+* Pagination methods depend only on link headers
+* Resources and collections are automatically inferred at parsing based
+  on the root key of the JSON response
+
+### Fixed
+* Properly handle requests and parsing of two_word resources (eg. filter_groups)
+* Make `Skroutz::Client#search` work
+
+## [0.0.4] - 2015-03-22
+### Changed
+
+* Make response timeout configurable (in seconds)
+* Make HTTP adapter configurable
+* Make response logger configurable
+
+### Fixed
+
+* Memoization in SkroutzApi::Resource#resource now works as expected

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing
+
+If you discover issues, have ideas for improvements or new features,
+please report them to the [issue tracker][1] of the repository or
+submit a pull request. Please, try to follow these guidelines when you
+do so.
+
+## Issue reporting
+
+* Check that the issue has not already been reported.
+* Check that the issue has not already been fixed in the latest code
+  (a.k.a. `master`).
+* Be clear, concise and precise in your description of the problem.
+* Open an issue with a descriptive title and a summary in grammatically correct,
+  complete sentences.
+* Mention the version of the gem you are using.
+* Include any relevant code to the issue summary.
+
+## Pull requests
+
+* Read [how to properly contribute to open source projects on Github][2].
+* Fork the project.
+* Use a topic/feature branch to easily amend a pull request later, if necessary.
+* Write [good commit messages][3].
+* Use the same coding conventions as the rest of the project.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Add an entry to the [Changelog](CHANGELOG.md) accordingly.
+* Make sure the test suite is passing and the code you wrote doesn't produce
+  RuboCop offenses.
+* [Squash related commits together][5].
+* Open a [pull request][4] that relates to *only* one subject with a clear title
+  and description in grammatically correct, complete sentences.
+
+This text is adapted from [rubocop - contributing](https://github.com/bbatsov/rubocop/blob/master/CONTRIBUTING.md)
+
+[1]: https://github.com/skroutz/skroutz.rb/issues
+[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: https://help.github.com/articles/using-pull-requests
+[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify gem dependencies in skroutz.gemspec
+gemspec
+
+group :development do
+  gem 'awesome_print', require: 'ap'
+  gem 'pry-debugger', platforms: :mri_19
+  gem 'pry-byebug', platforms: :mri_21
+  gem 'pry-doc'
+
+  gem 'guard-rubocop', require: false
+  gem 'rubocop', '~> 0.29.0'
+end
+
+group :test do
+  gem 'guard-rspec', require: false
+  gem 'coveralls', require: false
+  gem 'webmock', '>= 1.9'
+end

data/Guardfile

@@ -0,0 +1,17 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+rspec_options = {
+  cmd: 'bundle exec rspec --order rand'
+}
+
+guard 'rspec', rspec_options do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :rubocop, all_on_start: false, cli: '-D' do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0])  }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dimitris Zorbas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,301 @@
+# skroutz.rb
+
+[![Build Status](https://travis-ci.org/skroutz/skroutz.rb.svg?branch=master)](https://travis-ci.org/skroutz/skroutz.rb)
+[![Code Climate](https://codeclimate.com/github/skroutz/skroutz.rb/badges/gpa.svg)](https://codeclimate.com/github/skroutz/skroutz.rb)
+[![Coverage Status](https://coveralls.io/repos/skroutz/skroutz.rb/badge.svg)](https://coveralls.io/r/skroutz/skroutz.rb)
+[![Documentation Status](http://inch-ci.org/github/skroutz/skroutz.rb.svg?branch=master)](http://inch-ci.org/github/skroutz/skroutz.rb)
+
+Ruby API client for [Skroutz](https://skroutz.gr) / [Alve](https://alve.com) / [Scrooge](https://scrooge.co.uk)
+
+## Installation
+
+```bash
+gem install skroutz
+```
+
+Or add it to your Gemfile
+
+```ruby
+gem 'skroutz'
+```
+
+## Resources
+
+- [Category](http://developer.skroutz.gr/api/v3/category/)
+- [Sku](http://developer.skroutz.gr/api/v3/sku/)
+- [Product](http://developer.skroutz.gr/api/v3/product/)
+- [Shop](http://developer.skroutz.gr/api/v3/shop/)
+- [Manufacturer](http://developer.skroutz.gr/api/v3/manufacturer/)
+- [FilterGroup](http://developer.skroutz.gr/api/v3/filter_groups/)
+- [Favorite](http://developer.skroutz.gr/api/v3/favorites/)
+- [Notification](http://developer.skroutz.gr/api/v3/notifications/)
+
+## Creating a client
+
+```ruby
+  skroutz = Skroutz::Client.new('client_id', 'client_secret')
+```
+
+## Search
+
+```ruby
+  skroutz.search('iphone')
+
+  # => [#<Skroutz::Category id: 40, name: "Κινητά Τηλέφωνα", children_count: 0,
+  # image_url: "http://a.scdn.gr/images/categories/large/40.jpg", parent_id:
+  # 86, fashion: false, path: "76,1269,2,86,40", show_specifications: true,
+  # manufacturer_title: "Κατασκευαστές", match_count: 18>,
+  #  #<Skroutz::Category id: 583, name: "Ανταλλακτικά Κινητών τηλεφώνων",
+  # children_count: 0, image_url: "http://a.scdn.gr/images/categories/large/583.jpg", parent_id: 86,
+  # fashion: false, path: "76,1269,2,86,583", show_specifications: false,
+  # manufacturer_title: "Κατασκευαστές", match_count: 4062>
+  # ...
+```
+
+
+## Examples
+
+### Categories
+
+```ruby
+  skroutz = Skroutz::Client.new('client_id', 'client_secret')
+
+  mobile_phones = skroutz.categories.find 40
+
+  # => #<Skroutz::Category id: 40, name: "Κινητά Τηλέφωνα", children_count: 0,
+  # image_url: "http://a.scdn.gr/images/categories/large/40.jpg", parent_id:
+  # 86, fashion: false, path: "76,1269,2,86,40", show_specifications: true,
+  # manufacturer_title: "Κατασκευαστές">
+
+  # Get all categories, paginated
+  skroutz.categories.all
+  # => [#<Skroutz::Category id: 1, name: "Σταθερή Τηλεφωνία", children_count: 5, 
+  # image_url: "http://a.scdn.gr/images/categories/large/1.jpg", parent_id: 2, 
+  # fashion: false, path: "76,1269,2,1", show_specifications: false, 
+  # manufacturer_title: "Κατασκευαστές">,
+  #  #<Skroutz::Category id: 2, name: "Τηλεφωνία", children_count: 3,
+  # image_url: "http://d.scdn.gr/images/categories/large/201501271...",
+  # parent_id: 1269, fashion: false, path: "76,1269,2", show_specifications:
+  # false, manufacturer_title: "Κατασκευαστές">,
+  #  #<Skroutz::Category id: 5, name: "Φωτογραφία & Video", children_count:
+  # 3, image_url: "http://a.scdn.gr/images/categories/large/5.jpg",
+  # parent_id: 1269, fashion: false, path: "76,1269,5", show_specifications:
+  # false, manufacturer_title: "Κατασκευαστές">,
+  #  #<Skroutz::Category id: 6, name: "Διάφορα Εικόνας", children_count: 2,
+  # image_url: "http://c.scdn.gr/images/categories/large/201501271...",
+  # parent_id: 309, fashion: false, path: "76,1269,309,6",
+  # show_specifications: false, manufacturer_title: "Κατασκευαστές">,
+  # ...
+
+  # Get the SKUs of a Category without intermediate requests
+  skroutz.categories(40).skus
+  # => [#<Skroutz::Sku id: 2119391, ean: "", pn: "GT-E1200", name: "E1200",
+  # display_name: "Samsung E1200", category_id: 40, first_product_shop_info:
+  # nil, click_url: nil, price_max: 42.0, price_min: 12.61, reviewscore:
+  # 4.39286, shop_count: 20, plain_spec_summary: "Feature Phone,  Single
+  # SIM, Οθόνη: 1.52\" ,   Μνήμη...", manufacturer_id: 28, future: false,
+  # reviews_count: 28, virtual: false, images:
+  # {"main"=>"http://d.scdn.gr/images/sku_main_images/002119/2119391/medium_gr_GT-E1200ZWMVGR_301_Front",
+  # "alternatives"=>["http://a.scdn.gr/images/sku_images/012918/12918567/gr_GT-E1200ZWMVGR_309_Dynamic",
+  # "http://b.scdn.gr/images/sku_images/012918/12918568/gr_GT-E1200ZWMVGR_304_Left",
+  # "http://a.scdn.gr/images/sku_images/012918/12918573/gr_GT-E1200ZWMVGR_323_Right",
+  # "http://c.scdn.gr/images/sku_images/012918/12918574/gr_GT-E1200ZWMVGR_322_Back"]}>,
+  #  #<Skroutz::Sku id: 3599366, ean: ...
+ 
+
+```
+
+### SKUs
+
+```ruby
+  skroutz = Skroutz::Client.new('client_id', 'client_secret')
+
+  iphone = skroutz.skus.find 390486
+
+  # => #<Skroutz::Sku id: 390486, ean: "", pn: "iPhone 4S 16GB", name: "iPhone
+  # 4S (16GB)", display_name: "Apple iPhone 4S (16GB)", category_id: 40,
+  # first_product_shop_info: "1521|Kaizer Shop|kaizershop", click_url: nil,
+  # price_max: 310.0, price_min: 310.0, reviewscore: 4.43284, shop_count: 1,
+  # plain_spec_summary: "SmartPhone,  Single SIM, Οθόνη: 3.5\" , CPU: 1000
+  # M...", manufacturer_id: 356, future: false, reviews_count: 67, virtual:
+  # false, images:
+  # {"main"=>"http://d.scdn.gr/images/sku_main_images/000390/390486/medium_1234.jpg",
+  # "alternatives"=>["http://a.scdn.gr/images/sku_images/012928/12928351/Untitled.jpg",
+  # "http://b.scdn.gr/images/sku_images/012928/12928352/12345.jpg",
+  # "http://a.scdn.gr/images/sku_images/012928/12928353/smartfon-apple-iphone-4s-16gb-white-md239ru-i-a-30014672b.jpg",
+  # "http://a.scdn.gr/images/sku_images/012928/12928354/smartfon-apple-iphone-4s-16gb-white-md239ru-i-a-30014672b2.jpg",
+  # "http://b.scdn.gr/images/sku_images/012928/12928355/smartfon-apple-iphone-4s-16gb-white-md239ru-i-a-30014672b1.jpg"]}>
+```
+
+### Products
+
+```ruby
+  skroutz = Skroutz::Client.new('client_id', 'client_secret')
+
+  iphone_product = skroutz.products.find 12661155
+
+  # => #<Skroutz::Product id: 12661155, name: "APPLE IPHONE 4S 16GB white EU",
+  # sku_id: 390486, shop_id: 2032, category_id: 40, availability: "Σε απόθεμα", 
+  # click_url: "https://www.skroutz.gr/products/show/12661155?clie...", shop_uid: "312", 
+  # price: 364.49>
+
+```
+
+In this manner you may retrieve most [resources](#resources).
+
+## Pagination
+
+For paginated responses, the following methods will be available:
+
+* first_page?
+* last_page?
+* first
+* last
+* next
+* previous
+
+## Associations
+
+For every `Skroutz::Resource` the available associations can be inspected with:
+
+```ruby
+  skroutz = Skroutz::Client.new('client_id', 'client_secret')
+
+  iphone = skroutz.skus.find 390486
+  iphone.class.associations
+  # => [:category, :similar, :products, :reviews, :specifications, :manufacturer]
+```
+
+You may call any of the assocations listed you may them as methods like:
+
+```ruby
+  iphone = skroutz.skus.find 390486
+
+  # entity
+  iphone.category
+  # => #<Skroutz::Category id: 40, name: "Κινητά Τηλέφωνα", children_count: 0, image_url: "http://a.scdn.gr/images/categories/large/40.jpg", parent_id: 86, fashion: false, path: "76,1269,2,86,40", show_specifications: true, manufacturer_title: "Κατασκευαστές">
+
+  # collection
+  iphone.products.all
+  # => [#<Skroutz::Product id: 18733068, name: "Nokia 220 Single Sim EU Yellow", sku_id: 5725906, shop_id: 1830, category_id: 40, availability: "Σε απόθεμα", click_url: "https://www.skroutz.gr/products/show/18733068?clie...", shop_uid: "1149024", price: 36.0>,
+ #<Skroutz::Product id: 18036272, name: "Nokia 220 Dual Sim Black EU", sku_id: 5725906, shop_id: 941, category_id: 40, availability: "Σε απόθεμα", click_url: "https://www.skroutz.gr/products/show/18036272?clie...", shop_uid: "d30712b4-ed33-475e-9291-f3b3fafc40c9", price: 49.89>]
+```
+
+You may even try more complex things like:
+
+```ruby 
+  skroutz.search('nexus').first.skus.all.first.products.page(1, per: 2)
+  # => [#<Skroutz::Product id: 14343307, name: "TABLET INTENSO TAB 714
+  # 5509852", sku_id: 2690329, shop_id: 514, category_id: 1105, availability: "Σε απόθεμα", 
+  # click_url: "https://www.skroutz.gr/products/show/14343307?clie...", shop_uid: "180979", price: 37.99>,
+  # #<Skroutz::Product id: 14385461, name: "Intenso - Tablet 714 7''", sku_id: 2690329, 
+  # shop_id: 1085, category_id: 1105, availability: "1 έως 3 ημέρες", 
+  # click_url: "https://www.skroutz.gr/products/show/14385461?clie...", shop_uid: # "3210", price: 66.9>]
+
+  client.categories(40).skus(q: 'iphone').first.reviews.all
+  # => [#<Skroutz::Review id: 49553, user_id: 305635, review: "Αν μπορουσα θα του εβαζα 2.5 αντι για τρια. Αν και...", 
+  # rating: 3, created_at: "2015-03-16T22:05:56+02:00", demoted: false>, 
+  # #<Skroutz::Review id: 49477, user_id: 187662, review: "To κινητο δεν βρισκεται παρα πολυ καιρο στην κατοχ...", 
+  # rating: 5, created_at: "2015-03-15T16:38:38+02:00", demoted: false>,
+  # ...]
+```
+
+## Configuration
+
+The following configuration options are available upon client initialization:
+
+### logger
+
+Which logger to use.  
+**Default**: No logging is performed.
+
+Example: 
+
+```ruby
+# Log to STDOUT
+client = Skroutz::Client.new('client_id', 'client_secret', logger: Logger.new(STDOUT)) 
+```
+
+### timeout
+
+How much time (__in seconds__) to wait for a server response.  
+**Default**: 5 seconds
+
+### adapter
+
+Which HTTP adapter to use to perform the API requests.  
+**Default**: `Net::HTTP`  
+> Note: You can only pick a [faraday](https://github.com/lostisland/faraday) compatible adapter.  
+Make sure you have the gem of the selected adapter installed.
+
+### user_agent
+
+The user agent string to use for the API requests.  
+**Default**: `skroutz.rb`
+
+### api_endpoint
+
+The root URI of the targeted API.  
+**Default**: `https://api.skroutz.gr`
+
+### oauth_endpoint
+
+The endpoint from which to authorize via OAuth2.0.  
+**Default**: `https://skroutz.gr`
+
+### authorization_code_endpoint
+
+The endpoint from which to acquire OAuth2.0 [authorization code](https://tools.ietf.org/html/rfc6749#section-4.1).  
+**Default**: `/oauth2/authorizations/new`
+
+### token_endpoint
+
+The [endpoint](https://tools.ietf.org/html/rfc6749#section-3.2) from which to acquire OAuth2.0 access token.  
+**Default**: `/oauth2/token`
+
+### media type
+
+The value of the HTTP `Accept` header to specify the desired [media type](http://tools.ietf.org/html/rfc2046).  
+**Default**: `application/vnd.skroutz+json; version=3`
+
+### application_permissions
+
+The set of [permissions](http://developer.skroutz.gr/authorization/permissions/) to be obtained.  
+**Default**: `['public']
+
+## Compatibility
+
+The following Ruby implementations are supported:
+
+* MRI 1.9.3
+* MRI 2.1.0
+* MRI 2.2.0
+
+It may inadvertently work (or seem to work) on other Ruby implementations, 
+however support will only be provided for the versions listed above.
+
+## Development
+
+Please take some time to read our [contribution guide](CONTRIBUTING.md) first.
+
+### Running the tests
+
+Run all the tests:
+```bash
+bundle exec rake
+```
+
+Run them continuously with guard:
+```bash
+bundle exec guard
+```
+
+Fix any rubocop offences:
+```bash
+bundle exec rubocop
+```
+
+# LICENSE
+
+Copyright (c) 2015 Skroutz S.A, MIT Licence. 
+See [LICENSE.txt](https://github.com/skroutz/skroutz.rb/blob/master/LICENSE.txt) for further details.