seoshop-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjY5MWEwOGUzOGQ3MWQ3NDE5MTRhMjdkOWQwYTNjN2RjMDYwZmQ4MQ==
+    NjZhOTBlZmI0MDBjMWQwNjRmZjE0MjlmZGQ2NmFlOWM1YThjMzVmNA==
   data.tar.gz: !binary |-
-    Y2FiNzcyZTBjOTk3ZjA0MDVkZGZjMDVmYTdiODllMGNmZmJlMjU0Ng==
+    NmM4YTNhMTc5M2Y0MTQ1MTk2ZWFlNmNhODc2NGI2ZDUxOGQ5YjE0Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NTViNjVlYzFhZTQ0ZGIyNWEzZmM0YzMwYTY2YjJmOWNiZmQ1NTk0MGJmOTlh
-    NzZjZjFmMzVkNDJmOWU3Y2Q5OTlhNTEwNGM0MzRkNGVlNzBiYmNiMzE1MDgz
-    M2QyOWZkMTJiZmFhYTRiZWM2YjBhOTlkMTg3ZDEwMjU3YTlkZmI=
+    OWQwZjA3NzA3YzBmNjI2MGE2NThlOWI2NWZjYmI5NzU2NDdkZTdjMWIzZGJi
+    ZjYzYWFjYmI2YjIxMmI3NDAwNDkwMWRkMjNhYzdjNWJkNGE3ZjJmMmQxYmVh
+    ZGNlNWRlNjE4YTkzNmFjODMyZjBkNDY5NWUyZWRjMzMzOWFkYTI=
   data.tar.gz: !binary |-
-    MDFjMzZiYWQzNWExYzI0OGZmMmM5ZjM0M2EwNTNjODVlNjhkMDQzMjAxMWE1
-    MGE5MmM3MzJlM2Y0Mjk1YzFhM2ZiYmFjNzE2NDQwOGIwNWUxODdhNmQ0N2Rk
-    NmQzZGRlZGRlZTU4ZmZiNzFhNmRmZjFhNjg3NDhjNTZjODg5YTk=
+    NzVmNmY1ZGEyNTMxZmUwMzg5ZjNmOTk2MWJiMGIwN2Y5MmVlZDc1MTRhOGYw
+    MTc1MmIzN2I0ZTcxMTU5YjE2YWZiMzRiNzkyOTFjYjQ3YzJhMWY3MTQyZTQ5
+    M2U0MjYwODgwMzM2NzBhOWQ0MjY0ZDFkOGViOWIzNDdkNDM3OGQ=

data/.gitignore

@@ -1,3 +1,8 @@
+<<<<<<< HEAD
+pkg
+.DS_Store
+.idea/
+=======
 *.gem
 *.rbc
 .bundle
@@ -15,3 +20,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+>>>>>>> origin/master

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    seoshop-api (0.0.2)
+      activesupport
+      faraday
+      faraday_middleware
+      oauth2
+      oj
+      rash
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.12)
+    ethon (0.5.12)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    ffi (1.9.0)
+    hashie (2.0.5)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mime-types (1.23)
+    minitest (4.7.5)
+    multi_json (1.7.8)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    oj (2.1.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rash (0.4.0)
+      hashie (~> 2.0.0)
+    thread_safe (0.1.2)
+      atomic
+    typhoeus (0.6.3)
+      ethon (~> 0.5.11)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  seoshop-api!

data/README.md

@@ -18,7 +18,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Configure:
+```ruby
+
+Seoshop.configure do |conf|
+  conf.app_key = 'app_key'
+  conf.secret = 'secret'
+end
+```
+
+Use Client:
+
+```ruby
+
+shop_api = Seoshop.client('shop_token', 'shop_language')
+
+shop_api.get_shop
+```
+
 
 ## Contributing
 

data/lib/seoshop-api.rb

@@ -1,7 +1,58 @@
-require "seoshop-api/version"
+require 'seoshop-api/version'
+require 'seoshop-api/client'
 
 module Seoshop
-  module Api
-    # Your code goes here...
+  class << self
+    # @!attribute url
+    # @return [String] the base url of the Seoshop Api
+    attr_accessor :url
+
+    # @!attribute parallel_requests
+    # @return [Integer String] defines the maximum parallel request for the gem to preform
+    attr_accessor :parallel_requests
+
+    # @!attribute app_key
+    # @return [String] the app key that is registered with Storenvy
+    attr_accessor :app_key
+
+    # @!attribute secret
+    # @return [String] the secret that is registered with Storenvy
+    attr_accessor :secret
+
+    # Configuration interface of the gem
+    #
+    # @yield [self] to accept configuration settings
+    def configure
+      yield self
+      true
+    end
+
+    #
+    # Makes sure that the method missing is checked with the Seoshop::Client instance
+    #
+    # @param method_name [String] the name of the method we want to run
+    # @param include_private [Boolean] defines wether to check for private functions as well
+    def respond_to_missing?(method_name, include_private=false)
+      client.respond_to?(method_name, include_private)
+    end
+
+    #
+    # @return an instance of Seoshop::Client
+    #
+    def client(access_token, shop_language)
+      @client ||= Seoshop::Client.new(access_token, shop_language)
+    end
+
+    private
+
+    #
+    # executes any function on the Seoshop::Client instance
+    #
+    # @param args [*] any argument that we want to pass to the client function
+    # @param block [Block] any block that is passed to the client function
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
   end
 end

data/lib/seoshop-api/api/account.rb

@@ -0,0 +1,8 @@
+module Seoshop
+  module Account
+    def get_rate_limit
+      get("#{@shop_language}/account/ratelimit.json")['accountRatelimit']
+    end
+  end
+end
+

data/lib/seoshop-api/api/customer.rb

@@ -0,0 +1,15 @@
+module Seoshop
+  module Customer
+    def get_customers(params = {})
+      get("#{@shop_language}/customers.json", params)['customers']
+    end
+
+    def get_customers_count
+      get("#{@shop_language}/customers/count.json")['count']
+    end
+
+    def get_customer(customer_id)
+      get("#{@shop_language}/customers/#{customer_id}.json")['customer']
+    end
+  end
+end

data/lib/seoshop-api/api/order.rb

@@ -0,0 +1,19 @@
+module Seoshop
+  module Order
+    def get_orders(params = {})
+      get("#{@shop_language}/orders.json", params)['orders']
+    end
+
+    def get_orders_count
+      get("#{@shop_language}/orders/count.json")['count']
+    end
+
+    def get_order(order_id)
+      get("#{@shop_language}/orders/#{order_id}.json")['order']
+    end
+
+    def get_order_products(order_id)
+      get("#{@shop_language}/orders/#{order_id}/products.json")['order_products']
+    end
+  end
+end

data/lib/seoshop-api/api/product.rb

@@ -0,0 +1,15 @@
+module Seoshop
+  module Product
+    def get_products(params = {})
+      get("#{@shop_language}/products.json", params)['products']
+    end
+
+    def get_products_count
+      get("#{@shop_language}/products/count.json")['count']
+    end
+
+    def get_product(product_id)
+      get("#{@shop_language}/products/#{product_id}.json")['product']
+    end
+  end
+end

data/lib/seoshop-api/api/shop.rb

@@ -0,0 +1,16 @@
+module Seoshop
+  module Shop
+    def get_shop
+      get("#{@shop_language}/shop.json")['shop']
+    end
+
+    def get_shop_website
+      get("#{@shop_language}/shop/website.json")['shop_website']
+    end
+
+    def get_shop_company
+      get("#{@shop_language}/shop/company.json")['shop_company']
+    end
+  end
+end
+

data/lib/seoshop-api/client.rb

@@ -0,0 +1,149 @@
+require 'active_support/notifications'
+require 'faraday'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'faraday_middleware'
+require 'seoshop-api/core/response_parser'
+require 'seoshop-api/version'
+require 'seoshop-api/api/order'
+require 'seoshop-api/api/shop'
+require 'seoshop-api/api/product'
+require 'seoshop-api/api/customer'
+require 'seoshop-api/api/account'
+
+module Seoshop
+  class Client
+    include Seoshop::Order
+    include Seoshop::Shop
+    include Seoshop::Product
+    include Seoshop::Customer
+    include Seoshop::Account
+
+    attr_accessor :access_token
+    attr_accessor :shop_language
+
+    #
+    # Creates a new instance of Seoshop::Client
+    #
+    # @param url [String] The url to Seoshop api (https://api.webshopapp.com)
+    # @param parallel_requests [Integer String] The maximum parallel request to do (5)
+    def initialize(access_token, shop_language, url = 'https://api.webshopapp.com', parallel_requests = 5)
+      @access_token = access_token
+      @shop_language = shop_language
+      @url = url
+      @parallel_requests = parallel_requests
+    end
+
+    #
+    # Does a GET request to the url with the params
+    #
+    # @param url [String] the relative path in the Seoshop API
+    # @param params [Hash] the url params that should be passed in the request
+    def get(url, params = {})
+      params = params.inject({}){|memo,(k,v)| memo[k.to_s] = v; memo}
+      preform(url, :get, params: params) do
+        return connection.get(url, params).body
+      end
+    end
+
+    #
+    # Does a POST request to the url with the params
+    #
+    # @param url [String] the relative path in the Seoshop API
+    # @param params [Hash] the body of the request
+    def post(url, params)
+      params = convert_hash_keys(params)
+      preform(url, :post, params: params) do
+        return connection.post(url, params)
+      end
+    end
+
+    #
+    # Does a PUT request to the url with the params
+    #
+    # @param url [String] the relative path in the Seoshop API
+    # @param params [Hash] the body of the request
+    def put(url, params)
+      params = convert_hash_keys(params)
+      preform(url, :put, params: params) do
+        return connection.put(url, params)
+      end
+    end
+
+    #
+    # Does a DELETE request to the url with the params
+    #
+    # @param url [String] the relative path in the Seoshop API
+    def delete(url, params)
+      preform(url, :delete) do
+        return connection.delete(url)
+      end
+    end
+
+    #
+    # Does a parallel request to the api for all of the requests in the block
+    #
+    # @example block
+    #   Seoshop.in_parallel do
+    #     Seoshop.create_review(review_params)
+    #     Seoshop.update_account(account_params)
+    #   end
+    def in_parallel
+      connection.in_parallel do
+        yield
+      end
+    end
+
+    private
+
+    #
+    # Preforms an HTTP request and notifies the ActiveSupport::Notifications
+    #
+    # @private
+    # @param url [String] the url to which preform the request
+    # @param type [String]
+    def preform(url, type, params = {}, &block)
+      ActiveSupport::Notifications.instrument 'Seoshop', request: type, url: url, params: params do
+        if connection.in_parallel?
+          block.call
+        else
+          block.call.body
+        end
+      end
+    end
+
+    #
+    # @return an instance of Faraday initialized with all that this gem needs
+    def connection
+      @connection ||= Faraday.new(url: @url, parallel_manager: Typhoeus::Hydra.new(max_concurrency: @parallel_requests), headers: {:seoshop_api_connector => 'Ruby'+ Seoshop::VERSION}) do |conn|
+
+        conn.basic_auth(Seoshop.app_key, Digest::MD5.hexdigest(access_token + Seoshop.secret))
+
+        conn.use Seoshop::ResponseParser
+
+        # Set the response to be rashified
+        conn.response :rashify
+
+        # Setting request and response to use JSON/XML
+        conn.request :oj
+        conn.response :oj
+
+        # Set to use instrumentals to get time logs
+        conn.use :instrumentation
+
+        conn.adapter :typhoeus
+      end
+    end
+    private
+    def convert_hash_keys(value)
+      case value
+        when Array
+          value.map { |v| convert_hash_keys(v) }
+        when Hash
+          Hash[value.map { |k, v| [k.to_s, convert_hash_keys(v)] }]
+        else
+          value
+      end
+    end
+  end
+end

data/lib/seoshop-api/core/response_parser.rb

@@ -0,0 +1,92 @@
+require 'typhoeus/adapters/faraday'
+require 'faraday_middleware/response_middleware'
+
+module Seoshop
+  class ResponseParser < Faraday::Response::Middleware
+    def call(env)
+      # "env" contains the request
+      @app.call(env).on_complete do
+        body = false
+        if env[:status] == 200
+          body = env[:response].body.response || env[:response].body
+        elsif env[:status] == 401
+          raise Seoshop::ResponseParser::HTTPUnauthorized.new 'invalid Seoshop credentials'
+        elsif env[:response] && env[:response].body && env[:response].body.status
+          body = env[:response].body.status
+        end
+        env[:body] = body
+      end
+    end
+  end
+
+  #
+  # Response middleware that decodes the response body from JSON.
+  #
+  class ParseOj < FaradayMiddleware::ResponseMiddleware
+    dependency do
+      require 'oj' unless defined?(::Oj)
+    end
+
+    define_parser do |body|
+      begin
+        ::Oj.load(body, mode: :compat) unless body.strip.empty?
+      rescue Oj::ParseError => e
+      end
+    end
+  end
+
+  # Request middleware that encodes the body as JSON.
+  #
+  # Processes only requests with matching Content-type or those without a type.
+  # If a request doesn't have a type but has a body, it sets the Content-type
+  # to JSON MIME-type.
+  #
+  # Doesn't try to encode bodies that already are in string form.
+  class EncodeOj < Faraday::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+    MIME_TYPE    = 'application/json'.freeze
+
+    dependency do
+      require 'oj' unless defined?(::Oj)
+    end
+
+    def call(env)
+      match_content_type(env) do |data|
+        env[:body] = encode data
+      end
+      @app.call env
+    end
+
+    def encode(data)
+      ::Oj.dump data
+    end
+
+    def match_content_type(env)
+      if process_request?(env)
+        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+        yield env[:body] unless env[:body].respond_to?(:to_str)
+      end
+    end
+
+    def process_request?(env)
+      type = request_type(env)
+      has_body?(env) and (type.empty? or type == MIME_TYPE)
+    end
+
+    def has_body?(env)
+      body = env[:body] and !(body.respond_to?(:to_str) and body.empty?)
+    end
+
+    def request_type(env)
+      type = env[:request_headers][CONTENT_TYPE].to_s
+      type = type.split(';', 2).first if type.index(';')
+      type
+    end
+
+    class Seoshop::ResponseParser::HTTPUnauthorized < Exception
+    end
+  end
+end
+
+Faraday.register_middleware :response, oj: Seoshop::ParseOj
+Faraday.register_middleware :request, oj: Seoshop::EncodeOj

data/lib/seoshop-api/version.rb

@@ -1,5 +1,3 @@
 module Seoshop
-  module Api
-    VERSION = "0.0.1"
-  end
+  VERSION = '0.0.2'
 end

data/seoshop-api.gemspec

@@ -3,18 +3,29 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'seoshop-api/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "seoshop-api"
-  gem.version       = Seoshop::Api::VERSION
-  gem.authors       = ["Nimrod Popper"]
-  gem.email         = ["nimrod@yotpo.com"]
-  gem.description   = %q{Ruby wrapper for SEOshop API - written by Yotpo}
-  gem.summary       = %q{Ruby wrapper for SEOshop API - written by Yotpo}
-  gem.homepage      = "http://developers.webshopapp.com/rest-api/"
-  gem.license       = "MIT"
+Gem::Specification.new do |spec|
+  spec.name          = "seoshop-api"
+  spec.version       = Seoshop::VERSION
+  spec.authors       = ["Nimrod Popper"]
+  spec.email         = ["nimrod@yotpo.com"]
+  spec.description   = %q{Ruby wrapper for SEOshop API - written by Yotpo}
+  spec.summary       = %q{Ruby wrapper for SEOshop API - written by Yotpo}
+  spec.homepage      = "https://github.com/YotpoLtd/seoshop-api"
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-end
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'oauth2'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'rash'
+  spec.add_dependency 'oj'
+  spec.add_dependency 'activesupport'
+end

metadata

@@ -1,15 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: seoshop-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nimrod Popper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
-dependencies: []
+date: 2013-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: oauth2
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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'
+- !ruby/object:Gem::Dependency
+  name: rash
+  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'
+- !ruby/object:Gem::Dependency
+  name: oj
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: Ruby wrapper for SEOshop API - written by Yotpo
 email:
 - nimrod@yotpo.com
@@ -19,13 +145,21 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/seoshop-api.rb
+- lib/seoshop-api/api/account.rb
+- lib/seoshop-api/api/customer.rb
+- lib/seoshop-api/api/order.rb
+- lib/seoshop-api/api/product.rb
+- lib/seoshop-api/api/shop.rb
+- lib/seoshop-api/client.rb
+- lib/seoshop-api/core/response_parser.rb
 - lib/seoshop-api/version.rb
 - seoshop-api.gemspec
-homepage: http://developers.webshopapp.com/rest-api/
+homepage: https://github.com/YotpoLtd/seoshop-api
 licenses:
 - MIT
 metadata: {}