storenvy-api 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+.DS_Store
+.idea/
+

data/.ruby-gemset

@@ -0,0 +1 @@
+storenvy-api-ruby

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p429

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    storenvy-api (0.0.1)
+      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.9)
+    ethon (0.5.12)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    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.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    oauth2 (0.9.1)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    oj (2.1.2)
+    rack (1.5.2)
+    rake (10.0.4)
+    rash (0.4.0)
+      hashie (~> 2.0.0)
+    thread_safe (0.1.0)
+      atomic
+    typhoeus (0.6.3)
+      ethon (~> 0.5.11)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  storenvy-api!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Omri Cohen
+
+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,87 @@
+# Storenvy::Api::Ruby
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'storenvy-api-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install storenvy-api-ruby
+
+## Usage
+
+This is the flow you need to follow in order to communicate with Storenvy API.
+
+The first thing you wanna do, is to have Storenvy store owners authorize your application.
+
+```ruby
+
+require 'oauth2'
+
+
+oauth_client = OAuth2::Client.new "app_key",
+                                  "secret",
+                                  {:site => "https://www.storenvy.com/oauth"}
+
+authorize_uri = oauth_client.authorize_url :redirect_uri => "redirect_url", #must be consistent with the one defined in Storenvy API
+                                           :response_type => "code",
+                                           :scope => "user store_read store_write",
+                                           :client_id => oauth_client.client_credentials.client_params['client_id']
+
+```
+
+
+The users will be then redirected to the redirect_uri with the oauth2 code, you will need to convert the code to access_token for the future requests we are about to make.
+
+```ruby
+
+oauth_client = OAuth2::Client.new "app_key",
+                                  "secret",
+                                  {:site => "https://api.storenvy.com/oauth"}
+
+access_token = oauth_client.auth_code.get_token params[:code], {:redirect_uri => redirect_uri}
+shop_token = access_token.token
+
+```
+
+That's it, from now on, we will assume you have an access_token for the store your application is going to be integrated in.
+
+What we will do now, is to make some calls to the API. As mentioned before, each such call should get access_token as one of the parameters. Lets get all the shop products.
+
+
+```ruby
+
+products = []
+pagination_argument = nil
+begin
+  hsh = {:access_token => self.shop_token}
+  hsh[pagination_argument[0].to_sym] = pagination_argument[1] if pagination_argument
+
+  tmp_products = Storenvy.get_products hsh
+  products += tmp_products.body.data.products
+
+  pagination_argument = tmp_products.body.pagination.next_url.match(/newer_than_id=[0-9]+/).to_s.split("=") if tmp_products.body.pagination.next_url
+end while tmp_products.body.data.products.count > 0
+
+```
+
+That's it for now. We would love if you contribute more examples, as well as more functionality to this humble wrapper of us.
+
+We would also love it if some can help us write some tests.
+
+
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/lib/storenvy.rb

@@ -0,0 +1,58 @@
+require 'storenvy/version'
+require 'storenvy/client'
+
+module Storenvy
+  class << self
+    # @!attribute url
+    # @return [String] the base url of the Storenvy 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 Storenvy::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 Storenvy::Client
+    #
+    def client
+      @client ||= Storenvy::Client.new()
+    end
+
+    private
+
+    #
+    # executes any function on the Storenvy::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/storenvy/api/order.rb

@@ -0,0 +1,25 @@
+module Storenvy
+  module Order
+
+    #def update_account(params)
+    #  request = {
+    #      account: {
+    #        minisite_website_name: params[:minisite_website_name],
+    #        minisite_website: params[:minisite_website],
+    #        minisite_subdomain: params[:minisite_subdomain],
+    #        minisite_cname: params[:minisite_cname],
+    #        minisite_subdomain_active: params[:minisite_subdomain_active]
+    #      },
+    #      utoken: params[:utoken]
+    #  }
+    #  app_key = params[:app_key]
+    #  put("/apps/#{app_key}", request)
+    #end
+
+    def get_orders(params)
+      get("/v1/orders", params)
+    end
+
+  end
+end
+

data/lib/storenvy/api/product.rb

@@ -0,0 +1,24 @@
+module Storenvy
+  module Product
+    def get_products(params)
+      get("/v1/products", params)
+    end
+
+    def create_product(params)
+      post("/v1/products", params)
+    end
+
+    def get_product(product_id, params)
+      get("/v1/products/#{product_id}", params)
+    end
+
+    def update_product(product_id, params)
+      put("/v1/products/#{product_id}", params)
+    end
+
+    def delete_product(product_id, params)
+      delete("/v1/products/#{product_id}", params)
+    end
+  end
+end
+

data/lib/storenvy/api/store.rb

@@ -0,0 +1,13 @@
+module Storenvy
+  module Store
+    def current_store(params)
+      get("/v1/store", params)
+    end
+
+    def update_store(params)
+      put("/v1/store", params)
+    end
+
+  end
+end
+

data/lib/storenvy/api/template.rb

@@ -0,0 +1,12 @@
+module Storenvy
+  module Template
+    def get_templates(params)
+      get("/v1/store/templates", params)
+    end
+
+    def update_template(id, params)
+      put("/v1/store/templates/#{id}", params)
+    end
+  end
+end
+

data/lib/storenvy/api/user.rb

@@ -0,0 +1,8 @@
+module Storenvy
+  module User
+    def current_user(params)
+      get("/v1/me", params)
+    end
+  end
+end
+

data/lib/storenvy/client.rb

@@ -0,0 +1,150 @@
+require 'active_support/notifications'
+require 'faraday'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'faraday_middleware'
+require 'storenvy/core/response_parser'
+require 'storenvy/version'
+require 'storenvy/api/order'
+require 'storenvy/api/store'
+require 'storenvy/api/template'
+require 'storenvy/api/user'
+require 'storenvy/api/product'
+
+
+module Storenvy
+  class Client
+    include Storenvy::Order
+    include Storenvy::Store
+    include Storenvy::Template
+    include Storenvy::User
+    include Storenvy::Product
+
+    attr_accessor :access_token
+
+    #
+    # Creates a new instance of Storenvy::Client
+    #
+    # @param url [String] The url to Storenvy api (https://api.storenvy.com)
+    # @param parallel_requests [Integer String] The maximum parallel request to do (5)
+    def initialize(url = 'https://api.storenvy.com', parallel_requests = 5)
+      @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 Storenvy 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}
+      params[:access_token] = @access_token if @access_token
+      preform(url, :get, params: params) do
+        return connection.get(url, params)
+      end
+    end
+
+    #
+    # Does a POST request to the url with the params
+    #
+    # @param url [String] the relative path in the Storenvy API
+    # @param params [Hash] the body of the request
+    def post(url, params)
+      params = convert_hash_keys(params)
+      params[:access_token] = @access_token if @access_token
+      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 Storenvy API
+    # @param params [Hash] the body of the request
+    def put(url, params)
+      params = convert_hash_keys(params)
+      params[:access_token] = @access_token if @access_token
+      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 Storenvy API
+    def delete(url, params)
+      params = convert_hash_keys(params)
+      params[:access_token] = @access_token if @access_token
+      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
+    #   Storenvy.in_parallel do
+    #     Storenvy.create_review(review_params)
+    #     Storenvy.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 'Storenvy', 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: {:storenvy_api_connector => 'Ruby'+ Storenvy::VERSION}) do |conn|
+
+        conn.use Storenvy::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/storenvy/core/response_parser.rb

@@ -0,0 +1,84 @@
+require 'typhoeus/adapters/faraday'
+require 'faraday_middleware/response_middleware'
+
+module Storenvy
+  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[: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|
+      ::Oj.load(body, mode: :compat) unless body.strip.empty?
+    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
+  end
+end
+
+Faraday.register_middleware :response, oj: Storenvy::ParseOj
+Faraday.register_middleware :request, oj: Storenvy::EncodeOj

data/lib/storenvy/version.rb

@@ -0,0 +1,3 @@
+module Storenvy
+  VERSION = '0.0.1'
+end

data/storenvy-api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'storenvy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "storenvy-api"
+  spec.version       = Storenvy::VERSION
+  spec.authors       = ["Omri Cohen"]
+  spec.email         = ["omri@yotpo.com"]
+  spec.description   = %q{Ruby wrapper for Sotrenvy API - written by Yotpo}
+  spec.summary       = %q{Ruby wrapper for Sotrenvy API - written by Yotpo}
+  spec.homepage      = "https://developers.storenvy.com/docs"
+  spec.license       = "MIT"
+
+  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

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: storenvy-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Omri Cohen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Sotrenvy API - written by Yotpo
+email:
+- omri@yotpo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/storenvy.rb
+- lib/storenvy/api/order.rb
+- lib/storenvy/api/product.rb
+- lib/storenvy/api/store.rb
+- lib/storenvy/api/template.rb
+- lib/storenvy/api/user.rb
+- lib/storenvy/client.rb
+- lib/storenvy/core/response_parser.rb
+- lib/storenvy/version.rb
+- storenvy-api.gemspec
+homepage: https://developers.storenvy.com/docs
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 439492878140209227
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 439492878140209227
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for Sotrenvy API - written by Yotpo
+test_files: []