shoplo-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0a970fa7348e2e9912aeb695482ed8051773baf
+  data.tar.gz: c78be36583aa5590a9a19ef9487db05df8f91a13
+SHA512:
+  metadata.gz: 838a20e3a1eb8a5370129902ec6a12a50492376d39953344b66a76b4499572081d1ff0a057b4d56c0bd3925d4259363a9370e4f82f07706559528f3666920b31
+  data.tar.gz: b84f9d5e150f28c3bbdba0746b8e62bd5b264e9ca5353e4838af4c8dea4b67bb5ab996fc6c38adb99454d159bd76bbfd9ec804a11b2836e291e132871e90d9d8

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Max Gulyaev
+
+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,47 @@
+# Shoplo::Api
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shoplo-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shoplo-api
+
+## Usage
+
+Configure:
+```ruby
+
+Shoplo.configure do |conf|
+  conf.api_key = 'api_key'
+  conf.secret = 'secret'
+end
+```
+
+Create a client, and use it to call the Shoplo API.
+
+```ruby
+
+client = Shoplo::Client.new('access_token', 'token_secret')
+
+client.get_shop
+
+client.get_products
+```
+
+## 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/shoplo.rb

@@ -0,0 +1,46 @@
+require 'shoplo/client'
+require 'shoplo/version'
+
+module Shoplo
+  class << self
+    # @!attribute api_key
+    # @return [String] the API key that is registered with Shoplo
+    attr_accessor :api_key
+
+    # @!attribute secret
+    # @return [String] the secret that is registered with Shoplo
+    attr_accessor :secret
+
+    # Configuration interface of the gem
+    #
+    # @yield [self] to accept configuration settings
+    def configure
+      yield self
+      true
+    end
+
+    def client(access_token, token_secret)
+      @client ||= Shoplo::Client.new(access_token, token_secret)
+    end
+
+    #
+    # Makes sure that the method missing is checked with the Shoplo::Client instance
+    #
+    # @param method_name [String] the name of the method we want to run
+    # @param include_private [Boolean] defines whether to check for private functions as well
+    def respond_to_missing?(method_name, include_private=false)
+      client.respond_to?(method_name, include_private)
+    end
+
+    private
+    #
+    # executes any function on the Shoplo::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/shoplo/api/customer.rb

@@ -0,0 +1,9 @@
+module Shoplo
+  module API
+    module Customer
+      def get_customers(params = {})
+        get_content('customers', params)
+      end
+    end
+  end
+end

data/lib/shoplo/api/order.rb

@@ -0,0 +1,9 @@
+module Shoplo
+  module API
+    module Order
+      def get_orders(params = {})
+        get_content('orders', params)
+      end
+    end
+  end
+end

data/lib/shoplo/api/product.rb

@@ -0,0 +1,9 @@
+module Shoplo
+  module API
+    module Product
+      def get_products(params = {})
+        get_content('products', params)
+      end
+    end
+  end
+end

data/lib/shoplo/api/shop.rb

@@ -0,0 +1,9 @@
+module Shoplo
+  module API
+    module Shop
+      def get_shop
+        get_content('shop')
+      end
+    end
+  end
+end

data/lib/shoplo/client.rb

@@ -0,0 +1,49 @@
+require 'oauth'
+require 'oj'
+require 'uri'
+
+require 'shoplo/api/customer'
+require 'shoplo/api/order'
+require 'shoplo/api/product'
+require 'shoplo/api/shop'
+
+module Shoplo
+  class Client
+    include Shoplo::API::Customer
+    include Shoplo::API::Order
+    include Shoplo::API::Product
+    include Shoplo::API::Shop
+
+    def initialize(access_token, token_secret)
+      @access_token, @token_secret = access_token, token_secret
+    end
+
+    def consumer
+      @consumer ||= OAuth::Consumer.new(Shoplo.api_key, Shoplo.secret,
+        { site: 'http://api.shoplo.com/services' }
+      )
+    end
+
+    def connection
+      @connection ||= OAuth::AccessToken.new(consumer, @access_token, @token_secret)
+    end
+
+    def connection=(new_connection)
+      @connection = new_connection
+    end
+
+    def get_content(type, params = {})
+      id = params.delete(:id).to_i
+      id = '' if id <= 0
+      response = connection.get("/#{type}/#{id}?#{URI.encode_www_form(params)}")
+      json = Oj.load(response.body, mode: :compat)
+
+      raise HTTPUnauthorized.new(json['error_msg']) unless json['error'].nil?
+
+      json.values.first
+    end
+  end
+
+  class InvalidParams < Exception; end
+  class HTTPUnauthorized < Exception; end
+end

data/lib/shoplo/version.rb

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

data/shoplo-api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shoplo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shoplo-api'
+  spec.version       = Shoplo::VERSION
+  spec.authors       = ['Max Gulyaev']
+  spec.email         = ['maxim@yotpo.com']
+  spec.description   = %q{Ruby wrapper for shoplo API - written by Yotpo}
+  spec.summary       = %q{Ruby wrapper for shoplo API - written by Yotpo}
+  spec.homepage      = 'https://github.com/YotpoLtd/shoplo-api'
+  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 'oj', '~> 2.0'
+  spec.add_dependency 'oauth'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: shoplo-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Gulyaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-05 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: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  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 shoplo API - written by Yotpo
+email:
+- maxim@yotpo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- changelog
+- lib/shoplo.rb
+- lib/shoplo/api/customer.rb
+- lib/shoplo/api/order.rb
+- lib/shoplo/api/product.rb
+- lib/shoplo/api/shop.rb
+- lib/shoplo/client.rb
+- lib/shoplo/version.rb
+- shoplo-api.gemspec
+homepage: https://github.com/YotpoLtd/shoplo-api
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for shoplo API - written by Yotpo
+test_files: []