tictail-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78711afe2411c0fc32c9050a2aa6df9d660084b7
+  data.tar.gz: 424692df03b46dac4cb90309b122f9e2d5c91792
+SHA512:
+  metadata.gz: 284eb4af4386d7fed431f96db3c2f248e6f8454c3e9e621b36c2831b51bf931bce8b02ca21960b948fa0718f43d019a239bf62eb9c73e8d837124b1ccddbb0e7
+  data.tar.gz: 7d6fe7aeeabc660ff4ba6c6a4e0a4d0d57d9478f8ee61b79271b2862b83d198583d3082d04df50297db0468e20338a2601edbdeec15c7c42077368d1335a7e15

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 tictail-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alon Braitstein
+
+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,29 @@
+# Tictail::Api
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tictail-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tictail-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/changelog

@@ -0,0 +1,2 @@
+2013-07-25 Alon Braitstein
+1. Initial commit

data/lib/tictail/api/authenticate.rb

@@ -0,0 +1,18 @@
+module Tictail
+  module Api
+    module Authenticate
+      def authenticate(params)
+        params[:grant_type] = 'authorization_code'
+        response = Faraday.post do |req|
+          req.url 'https://tictail.com/oauth/token'
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.body = params.to_param
+        end
+        if response.status == 200 && response.body
+          response_hash = Oj.load(response.body, mode: :compat)
+          response_hash
+        end
+      end
+    end
+  end
+end

data/lib/tictail/api/client.rb

@@ -0,0 +1,99 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'tictail/faraday_middleware/response_parser'
+require 'tictail/faraday_middleware/encode_oj'
+require 'tictail/faraday_middleware/parse_oj'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+require 'tictail/api/authenticate'
+require 'tictail/api/ping'
+require 'tictail/helper'
+require 'tictail/api/order'
+require 'tictail/api/product'
+require 'tictail/api/customer'
+
+
+
+module Tictail
+  class Client
+    include Tictail::Helper
+    include Tictail::Api::Authenticate
+    include Tictail::Api::Ping
+    include Tictail::Api::Order
+    include Tictail::Api::Product
+    include Tictail::Api::Customer
+
+    attr_accessor :access_token
+
+    #
+    # Creates a new instance of Tictail::Api::Client
+    #
+    # @param url [String] The url to Tictail api (https://api.tictail.com)
+    def initialize(url = 'https://api.tictail.com')
+      @url = url
+    end
+
+
+    #
+    # Does a GET request to the url with the params
+    #
+    # @param url [String] the relative path in the Tictail 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}
+      @access_token = params.delete('access_token') if params['access_token']
+      return connection.get(url, params)
+    end
+
+    #
+    # Does a POST request to the url with the params
+    #
+    # @param url [String] the relative path in the Tictail API
+    # @param params [Hash] the body of the request
+    def post(url, params)
+      params = convert_hash_keys(params)
+      @access_token = params.delete('access_token') if params['access_token']
+      return connection.post(url, params)
+    end
+
+    #
+    # Does a PUT request to the url with the params
+    #
+    # @param url [String] the relative path in the Tictail API
+    # @param params [Hash] the body of the request
+    def put(url, params)
+      params = convert_hash_keys(params)
+      @access_token = params.delete('access_token') if params['access_token']
+      return connection.put(url, params)
+    end
+
+    #
+    # Does a DELETE request to the url with the params
+    #
+    # @param url [String] the relative path in the Tictail API
+    def delete(url, params)
+      params = convert_hash_keys(params)
+      @access_token = params.delete('access_token') if params['access_token']
+      return connection.delete(url)
+    end
+    private
+
+    def connection
+      header = {:tictail_api_connector => 'Ruby-'+ Tictail::Api::VERSION, 'Content-Type' => 'application/json' }
+      header.merge!({:Authorization => 'Bearer ' + access_token}) unless access_token.nil?
+      @connection ||= Faraday.new(url: @url, headers: header, ssl: {verify: true}) do |conn|
+
+        conn.use Tictail::ResponseParser
+
+        # Setting response parser to oj
+        conn.request :oj
+        conn.response :oj, :content_type => /\bjson$/
+
+        conn.adapter :typhoeus
+      end
+    end
+  end
+
+  class InvalidParams < Exception; end
+end

data/lib/tictail/api/customer.rb

@@ -0,0 +1,12 @@
+module Tictail
+  module Api
+    module Customer
+      def get_customer params
+        raise InvalidParams.new('No store id spacified') unless params[:store_id]
+        customer_id = params[:customer_id] ? "/#{params[:customer_id]}" : ''
+        response = get("/v1/stores/#{params[:store_id]}/customers" + customer_id, params)
+        response.body
+      end
+    end
+  end
+end

data/lib/tictail/api/order.rb

@@ -0,0 +1,12 @@
+module Tictail
+  module Api
+    module Order
+      def get_orders params
+        raise InvalidParams.new('No store id spacified') unless params[:store_id]
+        order_id = params[:order_id] ? "/#{params[:order_id]}" : ''
+        response = get("/v1/stores/#{params[:store_id]}/orders" + order_id, params)
+        response.body
+      end
+    end
+  end
+end

data/lib/tictail/api/ping.rb

@@ -0,0 +1,9 @@
+module Tictail
+  module Api
+    module Ping
+      def ping params
+        return get('/v1/teapot', params)
+      end
+    end
+  end
+end

data/lib/tictail/api/product.rb

@@ -0,0 +1,11 @@
+module Tictail
+  module Api
+    module Product
+      def get_products params
+        raise InvalidParams.new('No store id spacified') unless params[:store_id]
+        response = get("/v1/stores/#{params[:store_id]}/products", params)
+        response.body
+      end
+    end
+  end
+end

data/lib/tictail/api/version.rb

@@ -0,0 +1,5 @@
+module Tictail
+  module Api
+    VERSION = '0.0.1'
+  end
+end

data/lib/tictail/faraday_middleware/encode_oj.rb

@@ -0,0 +1,54 @@
+require 'faraday'
+
+module FaradayMiddleware
+  # 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 :request, oj: FaradayMiddleware::EncodeOj

data/lib/tictail/faraday_middleware/parse_oj.rb

@@ -0,0 +1,15 @@
+require 'faraday_middleware/response_middleware'
+
+module FaradayMiddleware
+  class ParseOj < ResponseMiddleware
+    dependency do
+      require 'oj' unless defined?(::Oj)
+    end
+
+    define_parser do |body|
+        ::Oj.load(body, mode: :compat) unless body.strip.empty?
+    end
+  end
+end
+
+Faraday.register_middleware :response, oj: FaradayMiddleware::ParseOj

data/lib/tictail/faraday_middleware/response_parser.rb

@@ -0,0 +1,14 @@
+module Tictail
+  class ResponseParser < Faraday::Response::Middleware
+    def call(env)
+      # "env" contains the request
+      @app.call(env).on_complete do
+        if env[:status] == 401 || env[:status] == 403
+          raise HTTPUnauthorized.new 'invalid storeenvy credentials'
+        end
+      end
+    end
+    class HTTPUnauthorized < Exception
+    end
+  end
+end

data/lib/tictail/helper.rb

@@ -0,0 +1,17 @@
+module Tictail
+  module Helper
+    def symbolize_keys hash
+      return hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+    end
+    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/tictail/tictail.rb

@@ -0,0 +1,29 @@
+require 'tictail/api/client'
+
+module Tictail
+  class << self
+    def client
+      @client ||= Tictail::Client.new()
+    end
+
+    #
+    # Makes sure that the method missing is checked with the Tictail::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
+
+    private
+    #
+    # executes any function on the Tictail::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/tictail-api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tictail/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tictail-api'
+  spec.version       = Tictail::Api::VERSION
+  spec.authors       = ['Alon Braitstein']
+  spec.email         = ['alon@yotpo.com']
+  spec.description   = %q{Ruby wrapper for tictail API - written by Yotpo}
+  spec.summary       = %q{Ruby wrapper for tictail API - written by Yotpo}
+  spec.homepage      = ''
+  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 'faraday'
+  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_dependency 'oj',                 '~> 2.0'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: tictail-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alon Braitstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler", "~> 1.3
+  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: 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: 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.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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'
+description: Ruby wrapper for tictail API - written by Yotpo
+email:
+- alon@yotpo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- changelog
+- lib/tictail/api/authenticate.rb
+- lib/tictail/api/client.rb
+- lib/tictail/api/customer.rb
+- lib/tictail/api/order.rb
+- lib/tictail/api/ping.rb
+- lib/tictail/api/product.rb
+- lib/tictail/api/version.rb
+- lib/tictail/faraday_middleware/encode_oj.rb
+- lib/tictail/faraday_middleware/parse_oj.rb
+- lib/tictail/faraday_middleware/response_parser.rb
+- lib/tictail/helper.rb
+- lib/tictail/tictail.rb
+- tictail-api.gemspec
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for tictail API - written by Yotpo
+test_files: []