shop_sensor 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd631022c4d2d6147b42774d1e4bd74243f65861
+  data.tar.gz: 885942f735564bc0a7fc75040cd4ba8385f18993
+SHA512:
+  metadata.gz: 48c85398ca9269f4247b4c7950d1a80152d9fa78468aca53a763672a89a7ba34a3af321c5c29627124246b9ed8852c2e109589bdda4fc0df2117b72c6371de30
+  data.tar.gz: 86fbac9c1d27b9a48f52d8262e658912ada1c9dff65307eb0e6ca219dd318813cfb346babbcebf88cccb6a55189728bd411b54292b17e8607cd114d913f62fe8

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shop_sensor.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Arai Hiroki
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Arai Hiroki
+
+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,45 @@
+shop_sensor
+===========
+
+This is unofficial client library of [ShopSense API](http://shopsense.shopstyle.com/shopsense/7234015).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shop_sensor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shop_sensor
+
+## Usage
+
+### Basic Request
+
+```
+client = ShopSensor::Client.new
+brands_response = client.brands # request to `/brands' endpoint
+products_response = client.products fts: "coat" # search on `/product' endpoint with keyword `coat'
+```
+
+### Configuration
+
+```
+ShopSensor.configure do |config|
+  config.api_key = '<YOUR API KEY>'
+  config.locale = :ja_JP # switch `site` parameter, and API returns correspond products.
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/hiroara/shop_sensor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/shop_sensor.rb

@@ -0,0 +1,16 @@
+require "shop_sensor/version"
+
+module ShopSensor
+  require 'shop_sensor/client'
+  require 'shop_sensor/configuration'
+  require 'shop_sensor/missing_configuration'
+
+  module_function
+  def configuration
+    @@configuration ||= Configuration.new
+  end
+
+  def configure &block
+    configuration.configure &block
+  end
+end

data/lib/shop_sensor/client.rb

@@ -0,0 +1,64 @@
+require 'faraday'
+
+module ShopSensor
+  class Client
+    attr_accessor :configuration
+
+    API_VERSION = 'v2'
+    API_ROOT_PATH = '/api'
+    API_HOST = "http://api.shopstyle.com"
+
+    def initialize
+      @configuration = ShopSensor.configuration.clone
+    end
+
+    def get endpoint, options={}
+      response = self.request endpoint, options
+      JSON.parse response.body
+    end
+
+    def request endpoint, options={}
+      raise ShopSensor::MissingConfiguration, :api_key unless @configuration.api_key
+      options[:format] ||= 'json'
+      path = File.join API_ROOT_PATH, API_VERSION, endpoint
+      connection.get path, options
+    end
+
+    def product prod_id
+      self.get "/products/#{prod_id}"
+    end
+
+    def configure &block
+      @connection = nil
+      @configuration.configure &block
+    end
+
+    private
+    def connection
+      @connection ||= Faraday.new(API_HOST, params: default_params) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def default_params
+      { pid: configuration.api_key, site: configuration.site }
+    end
+
+    def method_missing method, *args
+      return super unless simple_apis.include? method.to_s
+      get *([method.to_s] + args)
+    end
+
+    def simple_apis
+      [
+        'brands',
+        'products',
+        'categories',
+        'colors',
+        'retailers'
+      ]
+    end
+  end
+end

data/lib/shop_sensor/configuration.rb

@@ -0,0 +1,54 @@
+module ShopSensor
+  class Configuration
+    Config = Struct.new 'Config', :api_key, :locale
+
+    DEFAULTS = {
+      locale: :en_US
+    }
+    SITES = {
+      en_US: 'www.shopstyle.com',
+      en_GB: 'www.shopstyle.co.uk',
+      fr_FR: 'www.shopstyle.fr',
+      de_DE: 'www.shopstyle.de',
+      ja_JP: 'www.shopstyle.co.jp',
+      en_AU: 'www.shopstyle.com.au',
+      en_CA: 'www.shopstyle.ca'
+    }
+
+    def initialize settings={}
+      @config = Config.new
+      set DEFAULTS.merge(settings)
+    end
+
+    def configure &block
+      block.call @config
+      self
+    end
+
+    def clear!
+      set DEFAULTS
+    end
+
+    def site
+      SITES[@config.locale.intern]
+    end
+
+    def clone
+      self.class.new self.to_h
+    end
+
+    def to_h
+      @config.to_h
+    end
+
+    private
+    def method_missing method, *args
+      return super unless @config.members.include? method
+      @config.public_send method, *args
+    end
+
+    def set settings={}
+      @config.members.each { |member| @config[member] = settings[member] }
+    end
+  end
+end

data/lib/shop_sensor/missing_configuration.rb

@@ -0,0 +1,12 @@
+module ShopSensor
+  class MissingConfiguration < StandardError
+    def initialize *keys
+      super
+      @keys = keys
+    end
+
+    def message
+      "Missing configuration. [#{@keys.map(&:inspect).join(', ')}]"
+    end
+  end
+end

data/lib/shop_sensor/version.rb

@@ -0,0 +1,3 @@
+module ShopSensor
+  VERSION = "0.0.2"
+end

data/shop_sensor.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shop_sensor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shop_sensor"
+  spec.version       = ShopSensor::VERSION
+  spec.authors       = ["Arai Hiroki"]
+  spec.email         = ["hiroara62@gmail.com"]
+  spec.summary       = %q{Unofficial client library of ShopSense API}
+  spec.description   = %q{This is unofficial client library of ShopSense API (http://shopsense.shopstyle.com/shopsense/7234015).}
+  spec.homepage      = "https://github.com/hiroara/shop_sensor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rr'
+  spec.add_development_dependency 'hashie'
+
+  spec.add_dependency 'faraday'
+end

data/spec/shop_sensor/client_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'json'
+require 'hashie'
+
+describe ShopSensor::Client do
+  after { ShopSensor.configuration.clear! }
+
+  let(:client) { described_class.new }
+
+  shared_context 'some api_key is configured' do
+    before { ShopSensor.configure { |config| config.api_key = api_key } }
+    let(:api_key) { 'some_api_key' }
+  end
+
+  describe :initialize do
+    subject { client }
+    it do
+      expect(subject).to be_a ShopSensor::Client
+      expect(subject.configuration).to be_a ShopSensor::Configuration
+      expect(subject.configuration.api_key).to be_nil
+    end
+
+    context 'when api_key is configured' do
+      include_context 'some api_key is configured'
+      it { expect(subject.configuration.api_key).to eq api_key }
+    end
+  end
+
+  shared_context 'mocking API endpoint' do
+    before { mock(client).connection.with_no_args.at_least(1) { connection } }
+    let(:connection) { Faraday.new(ShopSensor::Client::API_HOST, params: client.send(:default_params)) { |builder| builder.adapter :test, faraday_stubs } }
+    let(:faraday_stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get(File.join("/api/v2", endpoint)) { [200, {}, response_body.to_json] }
+      end
+    end
+    let(:response_body) { { 'some' => 'object' } }
+  end
+
+  describe :request do
+    subject { client.request endpoint }
+    let(:endpoint) { 'brands' }
+    it { expect{ subject }.to raise_error ShopSensor::MissingConfiguration }
+
+    context 'when api_key is configured' do
+      include_context 'some api_key is configured'
+      include_context 'mocking API endpoint'
+      it do
+        expect{ subject }.not_to raise_error
+        expect(JSON.parse(subject.body)['some']).to eq 'object'
+      end
+
+      describe :params do
+        subject { client.request(endpoint).env.params }
+        it do
+          expect(subject['site']).to eq client.configuration.site
+          expect(subject['pid']).to eq api_key
+        end
+      end
+    end
+  end
+
+  describe :get do
+    include_context 'some api_key is configured'
+    include_context 'mocking API endpoint'
+    let(:endpoint) { '/brands' }
+    subject { client.get endpoint }
+    it { expect(subject).to eq response_body }
+  end
+
+  describe :simple_apis do
+    include_context 'some api_key is configured'
+    include_context 'mocking API endpoint'
+    let(:endpoint) { '/colors' }
+    subject { client.colors }
+    it { expect(subject).to eq response_body }
+  end
+
+  describe :product do
+    include_context 'some api_key is configured'
+    include_context 'mocking API endpoint'
+    let(:endpoint) { "/products/#{prod_id}" }
+    let(:prod_id) { '359131344' }
+    subject { client.product prod_id }
+    it { expect(subject).to eq response_body }
+  end
+
+  describe :configure do
+    subject { client.configuration.configure { |config| config.locale = :fr_FR } }
+    it { expect{ subject }.to change{ client.configuration.locale }.from(:en_US).to(:fr_FR) }
+  end
+end

data/spec/shop_sensor/configuration_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe ShopSensor::Configuration do
+  after { ShopSensor.configuration.clear! }
+
+  let(:configuration) { ShopSensor.configuration }
+  let(:api_key) { 'some_api_key' }
+
+  describe :initialize do
+    subject { described_class.new }
+    it do
+      expect(subject).to be_a ShopSensor::Configuration
+      expect(subject.locale).to eq :en_US
+    end
+  end
+
+  describe :configure do
+    subject do
+      configuration.configure do |config|
+        config.api_key = api_key
+      end
+    end
+    it do
+      expect{ subject }.to change{ configuration.api_key }.from(nil).to api_key
+      expect(subject).to be_a ShopSensor::Configuration
+    end
+  end
+
+  describe :clear! do
+    before { configuration.configure { |config| config.api_key = 'some_api_key' } }
+    subject { configuration.clear! }
+    it { expect{ subject }.to change{ configuration.api_key }.to nil }
+  end
+
+  describe :site do
+    subject { configuration.site }
+    context 'when default settings' do
+      it { expect(subject).to eq ShopSensor::Configuration::SITES[:en_US] }
+    end
+    context 'when custom settings' do
+      before { ShopSensor.configure { |config| config.locale = :ja_JP } }
+      it { expect(subject).to eq ShopSensor::Configuration::SITES[:ja_JP] }
+    end
+  end
+
+  describe :clone do
+    before { ShopSensor.configure { |config| config.api_key = api_key } }
+    after { ShopSensor.configuration.clear! }
+    let(:api_key) { 'some_api_key' }
+
+    subject { configuration.clone }
+    it { expect(subject.to_h).to eq configuration.to_h }
+
+    describe 'deep clone' do
+      let(:other_api_key) { 'other_api_key' }
+      it do
+        expect{ subject.configure{ |config| config.api_key = other_api_key } }.
+          not_to change{ configuration.api_key }.from(api_key)
+        expect(subject.api_key).to eq other_api_key
+      end
+    end
+  end
+end

data/spec/shop_sensor_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe ShopSensor do
+  it { expect(ShopSensor::VERSION).to eq "0.0.1" }
+
+  describe :configure do
+    subject { ShopSensor.configure &block }
+    let(:block) { proc { |config| @config = config } }
+    it { expect{ subject }.to change{ @config }.from nil }
+  end
+
+  describe :configuration do
+    subject { ShopSensor.configuration }
+    it { expect(subject).to be_a ShopSensor::Configuration }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'rspec'
+require 'shop_sensor'
+require 'rr'
+
+RSpec.configure do |config|
+  config.mock_framework = :rr
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: shop_sensor
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Arai Hiroki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is unofficial client library of ShopSense API (http://shopsense.shopstyle.com/shopsense/7234015).
+email:
+- hiroara62@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shop_sensor.rb
+- lib/shop_sensor/client.rb
+- lib/shop_sensor/configuration.rb
+- lib/shop_sensor/missing_configuration.rb
+- lib/shop_sensor/version.rb
+- shop_sensor.gemspec
+- spec/shop_sensor/client_spec.rb
+- spec/shop_sensor/configuration_spec.rb
+- spec/shop_sensor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hiroara/shop_sensor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Unofficial client library of ShopSense API
+test_files:
+- spec/shop_sensor/client_spec.rb
+- spec/shop_sensor/configuration_spec.rb
+- spec/shop_sensor_spec.rb
+- spec/spec_helper.rb