best_buy_ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ccf8ed1fc5f203f69ae21880739637bacd5815c8
-  data.tar.gz: a6c8f223588c5077ecf179b5897c4322c291c661
+SHA256:
+  metadata.gz: a0f26749ea4f679641b57f597c1361d281fb475a2fa83909afc450885407fe3a
+  data.tar.gz: 0a1f91dca71325a5bfcc1ca11bbae04151280d74f21d07141308c5cf8eaa2e24
 SHA512:
-  metadata.gz: 386d8d932c316fd59224462646d9a06bd8887a2c6cf220364d56a5f4556257fe6e1633387eca9ce3bb027e87acb14508e028e91a79e1324444f96a06b123c467
-  data.tar.gz: 49ca31364afd7c5eddbc5987afd412bc24f548aa7b00c472075b74f3ae5babd55a8a1379099094881e74f4e69491c3b7a42d6eacccbc613a0bd28e1f76bef35d
+  metadata.gz: b7efec1459b1d8bbdf2ae3581f8593074a0b776b9021cdb6280b9878e823a28f1389ddf89824c24a020330990952192eb49fbb5a18b850a7b72565eb0995ded1
+  data.tar.gz: 531da91fab6ad2f25a374b28125cf1e03ab936edb8aeb98b912a12011023e085d4daffade76e1eaa24a95828eb7716527cab862aed3961e77a34253c64ec96d4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.1.1
+- Added support for non Rails projects
+- Allowed APIs to use configured API key
+
 # 0.1.0
 - Added Products API
     - `get_all` method

data/CONTRIBUTING.md

@@ -1,15 +1,15 @@
 ## Contributing ##
 
-You can contribute to this repo if you have an issue, found a bug or think there's some functionality required that would add value to the gem. To do so, please check if there's not already an [issue](https://github.com/rootstrap/gem-base/issues) for that, if you find there's not, create a new one with as much detail as possible.
+You can contribute to this repo if you have an issue, found a bug or think there's some functionality required that would add value to the gem. To do so, please check if there's not already an [issue](https://github.com/rootstrap/best_buy_ruby/issues) for that, if you find there's not, create a new one with as much detail as possible.
 
 If you want to contribute with code as well, please follow the next steps:
 
-1. Read, understand and agree to our [code of conduct](https://github.com/rootstrap/gem-base/blob/master/CODE_OF_CONDUCT.md)
+1. Read, understand and agree to our [code of conduct](https://github.com/rootstrap/best_buy_ruby/blob/master/CODE_OF_CONDUCT.md)
 2. [Fork the repo](https://help.github.com/articles/about-forks/)
 3. Clone the project into your machine:
-`$ git clone git@github.com:[YOUR GITHUB USERNAME]/gem-base.git`
+`$ git clone git@github.com:rootstrap/best_buy_ruby.git`
 4. Access the repo:
-`$ cd gem-base`
+`$ cd best_buy_ruby`
 5. Create your feature/bugfix branch:
 `$ git checkout -b your_new_feature`
 or

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Juan Manuel Ramallo
+Copyright (c) 2020 Rootstrap
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -30,11 +30,11 @@ This will create this file: `config/initializers/best_buy.rb`
 
 ## Usage
 
-The gem can be used to access Best Buy [APIs](general-overview.md):
+The gem can be used to access Best Buy [APIs](docs/general_overview.md):
 
-- [Products](products-api.md)
-- [Stores](stores-api.md)
-- [Categories](categories-api.md)
+- [Products](docs/products_api.md)
+- [Stores](docs/stores_api.md)
+- [Categories](docs/categories_api.md)
 
 Example:
 
@@ -73,7 +73,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the RubyGemTemplate project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gem-base/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Best Buy Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rootstrap/best_buy_ruby/blob/master/CODE_OF_CONDUCT.md).
 
 ## Credits
 

data/best_buy_ruby.gemspec

@@ -27,16 +27,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Production dependencies
-  spec.add_dependency 'activesupport', '~> 6.0.2.1'
-  spec.add_dependency 'faraday', '~> 1.0.0'
+  spec.add_dependency 'activesupport', ['>= 4', '< 7']
+  spec.add_dependency 'faraday', '~> 1.0'
 
   # Development dependencies
-  spec.add_development_dependency 'ammeter'
-  spec.add_development_dependency 'railties'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'reek'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'ammeter', '~> 1.1'
+  spec.add_development_dependency 'railties', '~> 6.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'reek', '~> 5.6'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.80'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
+  spec.add_development_dependency 'webmock', '~> 3.8'
 end

data/docs/categories_api.md

@@ -22,4 +22,4 @@ Attributes:
 
 ## Interface
 
-(For more methods, check the [common API interface](general_overview.md#common-methods))
+(For more methods, check the [common API interface](general_overview.md#common-interface))

data/docs/general_overview.md

@@ -8,6 +8,31 @@ The different APIs accessible by this gem are:
 
 In spite of having each their own specification, they all share some basics listed here.
 
+## API key usage
+
+All APIs can be initialized by passing the API key in the `new` method
+
+```ruby
+BestBuy::Products.new(your_api_key)
+```
+But the key can also be set up in a `configure` method available for the `BestBuy` module:
+```ruby
+BestBuy.configure do |config|
+  config.api_key = 'your_api_key'
+end
+```
+Then, the next time you instantiate any API you can omit the key:
+
+```ruby
+BestBuy::Products.new
+```
+For Ruby on Rails projects you can run:
+
+    $ rails generate best_buy:config
+    
+To generate this file: `config/initializers/best_buy.rb`, where you can write the configuration code.
+
+For non Ruby on Rails projects, you can still write the configuration code wherever you like, as long as you make sure it runs before trying to access the APIs.
 ## Common interface
 
 This method can be used with any of the APIs:

data/docs/products_api.md

@@ -56,7 +56,7 @@ Attributes:
 
 ## Interface
 
-(For more methods, check the [common API interface](general_overview.md#common-methods))
+(For more methods, check the [common API interface](general_overview.md#common-interface))
 
 #### `get_by(conditions)`
 

data/docs/stores_api.md

@@ -49,7 +49,7 @@ store.address # returns '50 Holyoke St'
 
 ## Interface
 
-(For more methods, check the [common API interface](general_overview.md#common-methods))
+(For more methods, check the [common API interface](general_overview.md#common-interface))
 
 #### `find(store_id)`
 

data/lib/best_buy.rb

@@ -6,6 +6,8 @@ require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/string'
 require 'faraday'
 
+require 'best_buy/exceptions/api_key_not_found'
+
 require 'best_buy/helpers/api_helper'
 require 'best_buy/helpers/conditions/category_condition'
 require 'best_buy/helpers/conditions/max_price_condition'
@@ -14,6 +16,7 @@ require 'best_buy/helpers/conditions/new_condition'
 require 'best_buy/helpers/conditions/pre_owned_condition'
 require 'best_buy/helpers/conditions/refurbished_condition'
 
+require 'best_buy/config'
 require 'best_buy/base_api'
 require 'best_buy/categories'
 require 'best_buy/products'
@@ -31,4 +34,4 @@ require 'best_buy/models/product'
 require 'best_buy/models/shipping_level_of_service'
 require 'best_buy/models/store'
 
-require 'generators/best_buy/config/config_generator'
+require 'generators/best_buy/config/config_generator' if defined? Rails::Generators

data/lib/best_buy/base/version.rb

@@ -2,6 +2,6 @@
 
 module BestBuy
   module Base
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/best_buy/base_api.rb

@@ -11,7 +11,9 @@ module BestBuy
 
     attr_reader :api_key
 
-    def initialize(api_key)
+    def initialize(api_key = BestBuy.config.api_key)
+      raise Exceptions::ApiKeyNotFound unless api_key
+
       @api_key = api_key
     end
 

data/lib/best_buy/config.rb

@@ -6,6 +6,10 @@ module BestBuy
       yield config
     end
 
+    def reset_configuration
+      @config = Config.new
+    end
+
     def config
       @config ||= Config.new
     end

data/lib/best_buy/exceptions/api_key_not_found.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BestBuy
+  module Exceptions
+    class ApiKeyNotFound < StandardError
+      def message
+        'No API key configured. Either configure it in config/initializers/best_buy.rb '\
+          'or pass it as a parameter when creating the API instance.'
+      end
+    end
+  end
+end

metadata

@@ -1,155 +1,161 @@
 --- !ruby/object:Gem::Specification
 name: best_buy_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sandro Damilano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 6.0.2.1
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2.1
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: ammeter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.80'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.80'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 description: 
 email:
 - sandro.damilano@rootstrap.com
@@ -182,6 +188,7 @@ files:
 - lib/best_buy/base_api.rb
 - lib/best_buy/categories.rb
 - lib/best_buy/config.rb
+- lib/best_buy/exceptions/api_key_not_found.rb
 - lib/best_buy/helpers/api_helper.rb
 - lib/best_buy/helpers/conditions/category_condition.rb
 - lib/best_buy/helpers/conditions/max_price_condition.rb
@@ -226,8 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A wrapper for Best Buy APIs.