yotpo 0.0.2

data/lib/yotpo.rb

@@ -0,0 +1,58 @@
+require 'yotpo/version'
+require 'yotpo/client'
+
+module Yotpo
+  class << self
+    # @!attribute url
+    # @return [String] the base url of the Yotpo 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 Yotpo
+    attr_accessor :app_key
+
+    # @!attribute secret
+    # @return [String] the secret that is registered with Yotpo
+    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 Yotpo::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 Yotpo::Client
+    #
+    def client
+      @client ||= Yotpo::Client.new()
+    end
+
+    private
+
+    #
+    # executes any function on the Yotpo::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/spec/api/account_platform_spec.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+describe Yotpo::AccountPlatform do
+  describe '#create_account_platform' do
+    before(:all) do
+      create_account_platform_request = {
+          shop_token: 'asdasdadads',
+          shop_domain: Faker::Internet.domain_name,
+          plan_name: 'test plan',
+          platform_type_id: 1,
+          deleted: false,
+          utoken: 'asdeuh1di1udifn1309fn09',
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG'
+      }
+      stub_post("/apps/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/account_platform").
+          with(:headers => {'User-Agent' => 'Faraday v0.8.7', 'Yotpo-Api-Connector' => '0.0.1'}).
+          to_return(:status => 200, :body => fixture('new_account_platform.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+
+      @response = Yotpo.create_account_platform(create_account_platform_request)
+    end
+
+    subject { @response.body.account_platform }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :id }
+    it { should respond_to :shop_token }
+    it { should respond_to :shop_domain }
+    it { should respond_to :shop_api_url }
+    it { should respond_to :plan_name }
+    it { should respond_to :platform_type }
+    it { should respond_to :deleted }
+    it { should respond_to :shop_user_name }
+  end
+end

data/spec/api/account_spec.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+describe Yotpo::Account do
+  describe '#update_account' do
+    before(:all) do
+      account_data = {
+          minisite_website_name: Faker::Internet.domain_word,
+          minisite_website: Faker::Internet.domain_name,
+          minisite_subdomain: Faker::Internet.domain_name,
+          minisite_cname: Faker::Internet.domain_name,
+          minisite_subdomain_active: [true, false].sample,
+          utoken: '12ei1rr1i3ufn23itfoijver903',
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG'
+      }
+      stub_put('/apps/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG').
+          to_return(:status => 200, :body => fixture('update_account.json'), :headers => {})
+      @response = Yotpo.update_account(account_data)
+    end
+    subject { @response.body.app }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :id }
+    it { should respond_to :app_key }
+  end
+
+  describe '#check_minisite_subdomain' do
+    before(:all) do
+      sub_domain_data = {
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG',
+          subdomain: 'shalom1',
+          utoken: '12ei1rr1i3ufn23itfoijver903'
+      }
+      stub_get('/apps/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/subomain_check/shalom1?utoken=12ei1rr1i3ufn23itfoijver903').
+          with(:headers => {'User-Agent'=>'Faraday v0.8.7', 'Yotpo-Api-Connector'=>'0.0.1'}).
+          to_return(:status => 200, :body => fixture('check_subdomain.json'), :headers => {})
+
+      @response = Yotpo.check_minisite_subdomain(sub_domain_data)
+    end
+    subject { @response.body.subdomain }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :available }
+    it { should respond_to :subdomain }
+
+
+  end
+end

data/spec/api/product_spec.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+describe Yotpo::Product do
+  describe '#get_all_bottom_lines' do
+    before(:all) do
+      get_app_bottom_lines_params = {
+          utoken: 'asdeuh1di1udifn1309fn09',
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG'
+
+      }
+      stub_get("/apps/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/bottom_lines?utoken=asdeuh1di1udifn1309fn09").
+          with(:headers => {'User-Agent'=>'Faraday v0.8.7', 'Yotpo-Api-Connector'=>'0.0.1'}).
+          to_return(:status => 200, :body => fixture('get_all_bottom_lines.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+
+      @response = Yotpo.get_all_bottom_lines(get_app_bottom_lines_params)
+    end
+
+    subject { @response.body.bottomlines[0] }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :domain_key }
+    it { should respond_to :product_score }
+    it { should respond_to :total_reviews }
+  end
+
+  describe '#get_product_bottom_line' do
+    before(:all) do
+      get_bottom_line_params = {
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG',
+          product_id: 'A12'
+      }
+
+      stub_get("/products/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/A12/bottomline").
+          with(:headers => {'User-Agent'=>'Faraday v0.8.7', 'Yotpo-Api-Connector'=>'0.0.1'}).
+          to_return(:status => 200, :body => fixture('get_product_bottom_line.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+
+      @response = Yotpo.get_product_bottom_line(get_bottom_line_params)
+    end
+
+    subject { @response.body.bottomline }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :average_score }
+    it { should respond_to :total_reviews }
+  end
+end

data/spec/api/purchase_spec.rb

@@ -0,0 +1,100 @@
+require 'helper'
+
+describe Yotpo::Purchase do
+  describe '#create_new_purchase' do
+    before(:all) do
+      create_new_purchase_request = {
+          email: Faker::Internet.email,
+          customer_name: Faker::Internet.user_name,
+          order_id: '123',
+          platform: 'shopify',
+          products: [
+              p1: {
+                  url: 'http://example_product_url1.com',
+                  name: 'product1',
+                  image: 'http://example_product_image_url1.com',
+                  description: 'this is the description of a product'
+              }
+          ],
+          utoken: 'asdeuh1di1udifn1309fn09',
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG'
+      }
+      stub_post("/apps/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/purchases").
+          with(:headers => {'User-Agent' => 'Faraday v0.8.7', 'Yotpo-Api-Connector' => '0.0.1'}).
+          to_return(:status => 200, :body => fixture('new_purchase.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+
+      @response = Yotpo.create_new_purchase(create_new_purchase_request)
+    end
+
+    subject { @response.body }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :code }
+    it { should respond_to :message }
+  end
+
+  describe '#create_new_purchases' do
+    before(:all) do
+      create_new_purchase_request = {
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG',
+          utoken: 'asdeuh1di1udifn1309fn09',
+          orders: [
+              {
+                  email: Faker::Internet.email,
+                  customer_name: Faker::Internet.user_name,
+                  order_id: '123',
+                  platform: 'shopify',
+                  products: [
+                      p1: {
+                          url: 'http://example_product_url1.com',
+                          name: 'product1',
+                          image: 'http://example_product_image_url1.com',
+                          description: 'this is the description of a product'
+                      }
+                  ]
+
+
+              }
+          ]
+      }
+      stub_post("/apps/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/purchases/mass_create").
+          with(:headers => {'User-Agent' => 'Faraday v0.8.7', 'Yotpo-Api-Connector' => '0.0.1'}).
+          to_return(:status => 200, :body => fixture('new_purchase.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+
+      @response = Yotpo.create_new_purchases(create_new_purchase_request)
+    end
+
+    subject { @response.body }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :code }
+    it { should respond_to :message }
+  end
+
+  describe '#get_purchases' do
+    before(:all) do
+      get_purchases_request = {
+          utoken: 'asdeuh1di1udifn1309fn09',
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG'
+      }
+      stub_get('/apps/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/purchases?count=10&page=1&utoken=asdeuh1di1udifn1309fn09').
+          with(:headers => {'User-Agent' => 'Faraday v0.8.7', 'Yotpo-Api-Connector' => '0.0.1'}).
+          to_return(:status => 200, :body => fixture('get_list_of_purchases.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+
+      @response = Yotpo.get_purchases(get_purchases_request)
+    end
+
+    subject { @response.body.purchases[0] }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :id }
+    it { should respond_to :user_email }
+    it { should respond_to :user_name }
+    it { should respond_to :product_sku }
+    it { should respond_to :order_id }
+    it { should respond_to :product_name }
+    it { should respond_to :product_url }
+    it { should respond_to :order_date }
+    it { should respond_to :product_description }
+    it { should respond_to :product_image }
+    it { should respond_to :delivery_date }
+    it { should respond_to :created_at }
+  end
+end

data/spec/api/reminder_spec.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+describe Yotpo::Reminder do
+  describe Yotpo::Product do
+    describe '#send_test_reminder' do
+      before(:all) do
+        request ={
+            utoken: 'asdeuh1di1udifn1309fn09',
+            app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG',
+            email: 'vlad@yotpo.com'
+        }
+        stub_post('/apps/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/reminders/send_test_email').with(:body => Oj.dump({utoken: 'asdeuh1di1udifn1309fn09',
+                                                                                                                     email: 'vlad@yotpo.com'})).
+            to_return(:body => fixture('send_test_email.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+        @response = Yotpo.send_test_reminder(request)
+      end
+      subject { @response.body }
+      it { should be_a ::Hashie::Rash }
+      it { should respond_to :status }
+    end
+  end
+end

data/spec/api/review_spec.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+describe Yotpo::Review do
+
+  describe '#create_review' do
+    before(:all) do
+      anonymous_review = {
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG',
+          sku: Faker::Product.model,
+          domain: Faker::Internet.domain_name,
+          product_title: Faker::Product.product,
+          product_description: Faker::Lorem.paragraph(3),
+          product_url: Faker::Internet.http_url,
+          product_image_url: 'https://www.google.com/images/srpr/logo4w.png',
+          display_name: Faker::Internet.user_name,
+          email: Faker::Internet.email,
+          review_content: Faker::Lorem.paragraph(3),
+          review_title: Faker::Lorem.sentence(5),
+          review_score: [0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5].sample
+      }
+      stub_get('/reviews/dynamic_create').with(:query => hash_including({:app_key => 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG'})).to_return(:body => fixture('new_review.json'),
+                                                                                                                                             :headers => {:content_type => 'application/json; charset=utf-8'})
+      @response = Yotpo.create_review(anonymous_review)
+    end
+
+    subject { @response.body.reviews[0] }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :id }
+    it { should respond_to :user }
+    it { should respond_to :content }
+    it { should respond_to :title }
+  end
+
+  describe '#get_product_reviews' do
+    before(:all) do
+      get_reviews_params = {
+          page: 1,
+          count: 5,
+          app_key: 'nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG',
+          product_id: 'A12'
+      }
+      stub_get("/products/nNgGNA54ETOqaXQ7hRZymxqdtwwetJKDVs0v8qGG/A12/reviews?count=5&page=1").
+          with(:headers => {'User-Agent'=>'Faraday v0.8.7', 'Yotpo-Api-Connector'=>'0.0.1'}).
+          to_return(:status => 200, :body => fixture('get_product_reviews.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+      @response = Yotpo.get_product_reviews(get_reviews_params)
+    end
+
+    subject { @response.body.reviews[0] }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :id }
+    it { should respond_to :user }
+    it { should respond_to :content }
+    it { should respond_to :title }
+  end
+end

data/spec/api/user_spec.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+describe Yotpo::User do
+
+  describe '#create_user' do
+    before(:all) do
+      @user_info = {
+          email: Faker::Internet.email,
+          display_name: Faker::Internet.user_name,
+          first_name: Faker::Name.first_name,
+          last_name: Faker::Name.last_name,
+          website_name: Faker::Internet.domain_name,
+          password: Faker::Lorem.words(3).join(' '),
+          support_url: Faker::Internet.http_url,
+          callback_url: Faker::Internet.http_url,
+          url: Faker::Internet.http_url
+      }
+      stub_post('/users').with(:body => Oj.dump({:user => @user_info})).to_return(:body => fixture('new_user.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+      @response = Yotpo.create_user(@user_info)
+    end
+    subject { @response.body }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :app_key }
+    it { should respond_to :secret }
+    it { should respond_to :token }
+    it { should respond_to :id }
+  end
+
+  describe '#get_oauth_token' do
+    before(:all) do
+      oauth_request = {
+          app_key: 'a3lmMnC3u4SNmz0ZcHf3lODeIYM9LEQwtTWXRdDP',
+          secret: 'NumuadvlCGOTwnCCvY5BRAhGib1LTCFptYxfvebm',
+          grant_type: "client_credentials"
+      }
+      stub_request(:post, "https://api.yotpo.com/oauth/token").
+          with(:body => "{\":client_id\":\"a3lmMnC3u4SNmz0ZcHf3lODeIYM9LEQwtTWXRdDP\",\":client_secret\":\"NumuadvlCGOTwnCCvY5BRAhGib1LTCFptYxfvebm\",\":grant_type\":\"client_credentials\"}",
+               :headers => {'Content-Type'=>'application/json', 'User-Agent'=>'Faraday v0.8.7', 'Yotpo-Api-Connector'=>'0.0.1'}).
+          to_return(:status => 200, :body => fixture('bearer_token.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+      @response = Yotpo.get_oauth_token(oauth_request)
+    end
+    subject { @response.body }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :access_token }
+    it { should respond_to :token_type }
+  end
+
+  describe '#get_login_url' do
+    before(:all) do
+      request = {
+          app_key: 'a3lmMnC3u4SNmz0ZcHf3lODeIYM9LEQwtTWXRdDP',
+          secret: 'NumuadvlCGOTwnCCvY5BRAhGib1LTCFptYxfvebm'
+      }
+      stub_get('/users/b2blogin').with(:query => hash_including(request)).to_return(:body => fixture('get_login_url.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+      @response = Yotpo.get_login_url(request)
+    end
+    subject { @response.body }
+    it { should be_a ::Hashie::Rash }
+    it { should respond_to :code }
+    it { should respond_to :signin_url }
+
+  end
+end

data/spec/fixtures/bearer_token.json

@@ -0,0 +1,4 @@
+{
+    "access_token": "DUGKea0thVDL2muWzMAd7mYlkni46cJWhiX9tGTF",
+    "token_type": "bearer"
+}

data/spec/fixtures/check_subdomain.json

@@ -0,0 +1,12 @@
+{
+    "status" : {
+        "code" : 200,
+        "message" : "OK"
+    },
+    "response" : {
+        "subdomain" : {
+            "available" : "true",
+            "subdomain" : "shalom1"
+        }
+    }
+}

data/spec/fixtures/get_all_bottom_lines.json

@@ -0,0 +1,29 @@
+{
+    "status" : {
+        "code" : 200,
+        "message" : "OK"
+    },
+    "response" : {
+        "bottomlines" : [ {
+            "domain_key" : "62050632",
+            "product_score" : "3.45",
+            "total_reviews" : 11
+        }, {
+            "domain_key" : "62050052",
+            "product_score" : "3.0",
+            "total_reviews" : 3
+        }, {
+            "domain_key" : "62050122",
+            "product_score" : "4.64",
+            "total_reviews" : 11
+        }, {
+            "domain_key" : "73503772",
+            "product_score" : "4.76",
+            "total_reviews" : 17
+        }, {
+            "domain_key" : "92431514",
+            "product_score" : "4.52",
+            "total_reviews" : 25
+        }]
+    }
+}

data/spec/fixtures/get_list_of_purchases.json

@@ -0,0 +1,39 @@
+{
+    "status": {
+        "code": 200,
+        "message": "OK"
+    },
+    "response": {
+        "purchases": [
+            {
+                "id": 80,
+                "user_email": "test@use.com",
+                "user_name": "lamba",
+                "product_sku": "123",
+                "order_id": "100",
+                "product_name": "ttt",
+                "product_url": "http://www.google.com",
+                "order_date": "2013-05-06T16:45:40Z",
+                "product_description": "lalalala",
+                "product_image": "http://www.google.com/images/srpr/logo4w.png",
+                "delivery_date": "2013-05-19T21:00:00Z",
+                "created_at": "2013-05-20T16:45:40Z"
+            },
+            {
+                "id": 980,
+                "user_email": "test@use.com",
+                "user_name": "lamba",
+                "product_sku": "123",
+                "order_id": "1000",
+                "product_name": "ttt",
+                "product_url": "http://www.google.com",
+                "order_date": "2013-05-06T16:46:04Z",
+                "product_description": "lalalala",
+                "product_image": "http://www.google.com/images/srpr/logo4w.png",
+                "delivery_date": "2013-05-19T21:00:00Z",
+                "created_at": "2013-05-20T16:46:04Z"
+            }
+        ],
+        "total_purchases": 1001
+    }
+}

data/spec/fixtures/get_login_url.json

@@ -0,0 +1,10 @@
+{
+    "status" : {
+        "code" : 200,
+        "message" : "OK"
+    },
+    "response" : {
+        "code" : "pStQjjzuiUfRGX0EMhqi",
+        "signin_url" : "https://www.yotpo.com/callbacks/login?code=pStQjjzuiUfRGX0EMhqi"
+    }
+}

data/spec/fixtures/get_product_bottom_line.json

@@ -0,0 +1,12 @@
+{
+    "status":{
+        "code":200,
+        "message":"OK"
+    },
+    "response":{
+        "bottomline":{
+            "average_score":4.52,
+            "total_reviews":23
+        }
+    }
+}