yotpo 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2I3YTE0MTMxMmIxZjRiZTRiMWI4YTFmMWRmNmY4OTU2NmQwNGIyZQ==
+  data.tar.gz: !binary |-
+    ZDZhOGQ1MTViNDM3MjYyZDk4N2JkY2UxM2NiMGEyMjNiYzk5NjdjYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGEwNzY5YjRjYjAwMGFkZjJkY2ZmODQ2OGJiMGY3ZTM3YTFhNDhkZGI0MzIx
+    OTEwYjI5NzE1MWZjNWM2MmMxMzYyZTFhNTIzZTMyNWZlODI4ZTE4MDA2ZDQ4
+    OTE1ODQ5YjcxMWUzNzU5ODc3M2IwN2RiYWRkNTE0NDc1ZjhiMTA=
+  data.tar.gz: !binary |-
+    NTM0ODg4YmM0MTM1MzUwYTUyOWNkNTY0Yzg3NTMyNmE2MTIyODI0Njc5ZjJk
+    YjQ4NzQ0MTZkMTY4ZTVkYTBjZjU4Mjk3MDBjYzUyMDM1ZmQ1ZDNlYjZmZDJi
+    NjUzNGFmMzI2NjJkNTNhNjIyZDU5MzhlNzA3NDA0NWI1MmRkODg=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--order random

data/.ruby-gemset

@@ -0,0 +1 @@
+yotpo-api-connector

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'yard'
+gem 'redcarpet'
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'rspec'
+  gem 'simplecov', :require => false
+  gem 'webmock'
+  gem 'ffaker'
+end
+
+# Specify your gem's dependencies in yotpo-api-connector.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vladislav Shub
+
+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,51 @@
+# Yotpo
+
+A Ruby interface to the YOTPO API
+
+[gem]: http://rubygems.org/gems/yotpo
+[travis]: http://travis-ci.org/YotpoLtd/yotpo-ruby
+[gemnasium]: https://gemnasium.com/YotpoLtd/yotpo-ruby
+[codeclimate]: https://codeclimate.com/github/YotpoLtd/yotpo-ruby
+[coveralls]: https://coveralls.io/r/YotpoLtd/yotpo-ruby
+
+[![Gem Version](https://badge.fury.io/rb/yotpo.png)][gem]
+[![Build Status](https://secure.travis-ci.org/YotpoLtd/yotpo-ruby.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/YotpoLtd/yotpo-ruby.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/YotpoLtd/yotpo-ruby.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/YotpoLtd/yotpo-ruby/badge.png?branch=master)][coveralls]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yotpo'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yotpo
+
+## Usage
+
+First [register your application with Yotpo][register]
+Then copy and past the app_key and secret
+```ruby
+Yotpo.configure do |config|
+  config.app_key = APP_KEY
+  config.secret = SECRET
+end
+```
+That is it you are ready
+
+[register]: https://www.yotpo.com/register
+
+## 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,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/yotpo/api/account.rb

@@ -0,0 +1,45 @@
+module Yotpo
+  module Account
+
+    #
+    # Updates account at Yotpo
+    #
+    # @param params [Hash] the account basic information
+    # @option params [String] :minisite_website_name the name to display at the yotpo-minisite
+    # @option params [String] :minisite_website the website to link the minisite to
+    # @option params [String] :minisite_subdomain the subdomain at yotpo.me to use for this account
+    # @option params [String] :minisite_cname the cname that will point to the subdomain.yotpo.com
+    # @option params [Boolean Integer] :minisite_subdomain_active enable or disable the feature
+    # @option params [String] :utoken the login token of the account owner
+    # @option params [String] :app_key the account app key that was created at registration
+    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
+
+    #
+    # Check if the minisite subdomain at yotpo.me is vacant
+    #
+    # @param params [Hash]
+    # @option params [String] :utoken the login token of the account owner
+    # @option params [String] :app_key the account app key that was created at registration
+    # @option params [String] :subdomain the subdomain to check
+    def check_minisite_subdomain(params)
+      app_key = params[:app_key]
+      subdomain = params[:subdomain]
+      utoken = params[:utoken]
+      get("/apps/#{app_key}/subomain_check/#{subdomain}?utoken=#{utoken}")
+    end
+  end
+end
+

data/lib/yotpo/api/account_platform.rb

@@ -0,0 +1,20 @@
+module Yotpo
+  module AccountPlatform
+    def create_account_platform(params)
+      request ={
+           account_platform: {
+            shop_token: params[:shop_token],
+            shop_domain: params[:shop_domain],
+            plan_name: params[:plan_name],
+            platform_type_id: params[:platform_type_id],
+            deleted: false
+          },
+          utoken: params[:utoken]
+      }
+      app_key = params[:app_key]
+      post("/apps/#{app_key}/account_platform", request)
+    end
+  end
+end
+
+

data/lib/yotpo/api/product.rb

@@ -0,0 +1,25 @@
+module Yotpo
+  module Product
+    def get_all_bottom_lines(params)
+      request = {
+          utoken: params[:utoken],
+          since_date: params[:since_date],
+          since_id: params[:since_id]
+      }
+      request.delete_if{|key,val| val.nil?}
+      app_key = params[:app_key]
+      get("/apps/#{app_key}/bottom_lines", request)
+    end
+
+    #
+    # Retrieves the bottom line of a product
+    # @param params [Hash]
+    # @option params [String] :app_key the accounts app key that was given to it upon registration
+    # @option params [String] :product_id the id of the product
+    def get_product_bottom_line(params)
+      app_key = params[:app_key]
+      sku = params[:product_id]
+      get("/products/#{app_key}/#{sku}/bottomline")
+    end
+  end
+end

data/lib/yotpo/api/purchase.rb

@@ -0,0 +1,38 @@
+module Yotpo
+  module Purchase
+    def create_new_purchase(params)
+      request = {
+          utoken: params[:utoken],
+          email: params[:email],
+          customer_name: params[:customer_name],
+          order_id: params[:order_id],
+          platform: params[:platform],
+          products: params[:products]
+      }
+      app_key = params[:app_key]
+      post("/apps/#{app_key}/purchases", request)
+    end
+
+    def create_new_purchases(params)
+      request = {
+          utoken: params[:utoken],
+          orders: params[:orders]
+      }
+      app_key = params[:app_key]
+      post("/apps/#{app_key}/purchases/mass_create", request)
+    end
+
+    def get_purchases(params)
+      request ={
+          utoken: params[:utoken],
+          since_id: params[:since_id],
+          since_date: params[:since_date],
+          page: params[:page] || 1,
+          count: params[:count] || 10
+      }
+      request.delete_if{|key, value| value.nil? }
+      app_key = params[:app_key]
+      get("/apps/#{app_key}/purchases", request)
+    end
+  end
+end

data/lib/yotpo/api/reminder.rb

@@ -0,0 +1,14 @@
+module Yotpo
+  module Reminder
+    def send_test_reminder(params)
+      request ={
+          utoken: params[:utoken],
+          email: params[:email]
+      }
+      app_key = params[:app_key]
+      post("/apps/#{app_key}/reminders/send_test_email", request)
+    end
+  end
+end
+
+

data/lib/yotpo/api/review.rb

@@ -0,0 +1,67 @@
+module Yotpo
+  module Review
+
+    # Creates a new review in Yotpo
+    #
+    # @param [Hash] params
+    # @option params [String] :app_key the app key of the account for which the review is created
+    # @option params [String] :product_id the id of the product
+    # @option params [String] :shop_domain the domain of the account
+    # @option params [String] :product_title the name of the product for which the review is created
+    # @option params [String] :product_description the description of the product for which the review is created
+    # @option params [String] :product_url the url of the product for which the review is created
+    # @option params [String] :product_image_url the image url of the product for which the review is created
+    # @option params [String] :user_display_name the author name
+    # @option params [String] :user_email the author email
+    # @option params [String] :review_body the review itself
+    # @option params [String] :review_title the review title
+    # @option params [String Integer] :review_score the rating of the review
+    # @option params [String] :utoken the token of the user who wrote the review (if one exists)
+    # @return [::Hashie::Rash] The new review with all of it's date
+    def create_review(params)
+      request = {
+          app_key: params[:app_key],
+          sku: params[:product_id],
+          domain: params[:shop_domain],
+          product_title: params[:product_title],
+          product_description: params[:product_description],
+          product_url: params[:product_url],
+          product_image_url: params[:product_image_url],
+          display_name: params[:user_display_name],
+          email: params[:user_email],
+          review_content: params[:review_body],
+          review_title: params[:review_title],
+          review_score: params[:review_score],
+          utoken: params[:utoken]
+      }
+      request.delete_if {|element, value| value.nil? }
+      get('/reviews/dynamic_create', request)
+    end
+
+
+    #
+    # Gets reviews of a specific product
+    #
+    # @param [Hash] params
+    # @option params [String] :app_key the app key of the account for which the review is created
+    # @option params [String] :product_id the id of the product
+    # @option params [Integer] :count the amount of reviews per page
+    # @option params [Integer] :page the page number
+    # @option params [String] :since_id the id from which to start retrieving reviews
+    # @option params [String] :since_date the date from which to start retrieving reviews
+    # @option params [String] :utoken the users utoken to get the reviews that are most relevant to that user
+    def get_product_reviews(params)
+      app_key = params[:app_key]
+      sku = params[:product_id]
+      request = {
+          page: params[:page] || 1,
+          count: params[:per_page] || 5,
+          since_date: params[:since_date],
+          since_id: params[:since_id],
+          utoken: params[:utoken]
+      }
+      request.delete_if{|key,val| val.nil? }
+      get("/products/#{app_key}/#{sku}/reviews", request)
+    end
+  end
+end

data/lib/yotpo/api/user.rb

@@ -0,0 +1,64 @@
+module Yotpo
+  module User
+
+    #
+    # Registers a new User with Yotpo
+    #
+    # @param params [Hash] the user details hash
+    # @option params [String] :email the email of the user
+    # @option params [String] :display_name the display name of the user
+    # @option params [String] :first_name the first name of the user
+    # @option params [String] :last_name the last name of the user
+    # @option params [String] :website_name the name of the web site that the user owns
+    # @option params [String] :domain the domain of the web site that the user owns
+    # @option params [String] :url the url of the web site that the user owns
+    # @option params [String] :support_url the support url at the users site
+    # @option params [String] :callback_url the beginning of the callback url at the users site
+    # @return the new account hash
+    def create_user(params)
+      user = {
+          email: params[:email],
+          display_name: params[:display_name],
+          first_name: params[:first_name],
+          last_name: params[:last_name],
+          website_name: params[:website_name],
+          password: params[:password],
+          support_url: params[:support_url],
+          callback_url: params[:callback_url],
+          url: params[:url]
+      }
+      post('/users', {user: user})
+    end
+
+    #
+    # Retrieves an oauth bearer token from Yotpo
+    #
+    # @param params [Hash] the request details
+    # @option params [String] :client_id the app key received at the registration
+    # @option params [String] :client_secret app secret received at the registration
+    # @return [Hash] that includes access_token and the token_type
+    def get_oauth_token(params)
+      request = {
+          client_id: params[:app_key],
+          client_secret: params[:secret],
+          grant_type: "client_credentials"
+      }
+
+      response = post('/oauth/token', request)
+      return response
+    end
+
+    #
+    # To allow the login into www.yotpo.com using app_key and secret
+    # @param params [Hash] the request params
+    # @option params [String] :app_key that was received when registered to www.yotpo.com
+    # @option params [String] :secret that was received when registered to www.yotpo.com
+    def get_login_url(params)
+      request = {
+          app_key: params[:app_key],
+          secret: params[:secret]
+      }
+      get('/users/b2blogin', request)
+    end
+  end
+end

data/lib/yotpo/client.rb

@@ -0,0 +1,134 @@
+require 'active_support/notifications'
+require 'faraday'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'faraday_middleware'
+require 'yotpo/core/response_parser'
+require 'yotpo/version'
+require 'yotpo/api/account'
+require 'yotpo/api/account_platform'
+require 'yotpo/api/product'
+require 'yotpo/api/purchase'
+require 'yotpo/api/reminder'
+require 'yotpo/api/review'
+require 'yotpo/api/user'
+
+module Yotpo
+  class Client
+    include Yotpo::Account
+    include Yotpo::AccountPlatform
+    include Yotpo::Product
+    include Yotpo::Reminder
+    include Yotpo::Review
+    include Yotpo::User
+
+    include Yotpo::Purchase
+
+
+    #
+    # Creates a new instance of Yotpo::Client
+    #
+    # @param url [String] The url to yotpo api (https://api.yotpo.com)
+    # @param parallel_requests [Integer String] The maximum parallel request to do (5)
+    def initialize(url = 'https://api.yotpo.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 Yotpo API
+    # @param params [Hash] the url params that should be passed in the request
+    def get(url, params = {})
+      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 Yotpo API
+    # @param params [Hash] the body of the request
+    def post(url, 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 Yotpo API
+    # @param params [Hash] the body of the request
+    def put(url, 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 Yotpo API
+    def delete(url)
+      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
+    #   Yotpo.in_parallel do
+    #     Yotpo.create_review(review_params)
+    #     Yotpo.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 'Yotpo', 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: {:yotpo_api_connector => Yotpo::VERSION}) do |conn|
+
+        conn.use Yotpo::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
+  end
+end

data/lib/yotpo/core/response_parser.rb

@@ -0,0 +1,84 @@
+require 'typhoeus/adapters/faraday'
+require 'faraday_middleware/response_middleware'
+
+module Yotpo
+  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: Yotpo::ParseOj
+Faraday.register_middleware :request, oj: Yotpo::EncodeOj

data/lib/yotpo/version.rb

@@ -0,0 +1,3 @@
+module Yotpo
+  VERSION = '0.0.2'
+end