duodealer_api 1.0.0

data/test/application_charge_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+class ApplicationChargeTest < Test::Unit::TestCase
+
+  def test_application_charge_create
+    fake "application_charges", :method => :post, :status => 201, :body => load_fixture('application_charge')
+
+    charge = DuodealerAPI::ApplicationCharge.create(
+        name: "iPod Cleaning",
+        price: 5.00,
+        return_url: "http://google.com"
+    )
+
+    assert_equal 'https://this-is-my-test-shop.duodealer.com/admin/charges/803742/confirm_application_charge?signature=BAhpA55DDA%3D%3D--55b44e274e438c619be4631c804abcbcb6ee915a', charge.confirmation_url
+  end
+
+  def test_get_application_charge
+    fake "application_charges/803742", :method => :get, :status => 201, :body => load_fixture('application_charge')
+
+    charge = DuodealerAPI::ApplicationCharge.find(803742)
+
+    assert_equal "iPod Cleaning", charge.name
+  end
+
+  def test_list_application_charges
+    fake "application_charges", :method => :get, :status => 201, :body => load_fixture('application_charges')
+
+    charges = DuodealerAPI::ApplicationCharge.find(:all)
+
+    assert_equal 4, charges.size
+    assert_equal "iPhone Case", charges.last.name
+  end
+
+  def test_list_pending_application_charges
+    fake "application_charges", :method => :get, :status => 201, :body => load_fixture('application_charges')
+
+    pending_charges = DuodealerAPI::ApplicationCharge.pending
+
+    assert_equal 1, pending_charges.size
+    assert_equal "Screen Replacement", pending_charges.first.name
+  end
+
+  def test_list_expired_application_charges
+    fake "application_charges", :method => :get, :status => 201, :body => load_fixture('application_charges')
+
+    expired_charges = DuodealerAPI::ApplicationCharge.expired
+
+    assert_equal 1, expired_charges.size
+    assert_equal "iPod Cleaning", expired_charges.first.name
+  end
+
+  def test_list_accepted_application_charges
+    fake "application_charges", :method => :get, :status => 201, :body => load_fixture('application_charges')
+
+    accepted_charges = DuodealerAPI::ApplicationCharge.accepted
+
+    assert_equal 1, accepted_charges.size
+    assert_equal "iPhone Case", accepted_charges.first.name
+  end
+
+  def test_list_declined_application_charges
+    fake "application_charges", :method => :get, :status => 201, :body => load_fixture('application_charges')
+
+    declined_charges = DuodealerAPI::ApplicationCharge.declined
+
+    assert_equal 1, declined_charges.size
+    assert_equal "Magic Mouse", declined_charges.first.name
+  end
+
+  def test_activate_application_charge
+    fake "application_charges", :method => :get, :status => 201, :body => load_fixture('application_charges')
+    fake "application_charges/803740/activate", :method => :post, :status => 200, :body => "{}"
+
+    charge = DuodealerAPI::ApplicationCharge.accepted
+
+    assert charge.last.activate
+  end
+
+end

data/test/application_credit_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class ApplicationCreditTest < Test::Unit::TestCase
+  def test_application_credit_create
+    fake "application_credits", method: :post, status: 201, body: load_fixture('application_credit')
+
+    credit = DuodealerAPI::ApplicationCredit.create(
+      description: "refund for application charge",
+      amount: 5.00,
+      api_client_id: 861378,
+      shop_id: 487168
+    )
+
+    assert_equal 'refund for application charge', credit.description
+    assert_equal '5.00', credit.amount
+  end
+
+  def test_get_application_credit
+    fake "application_credits/803742", method: :get, status: 201, body: load_fixture('application_credit')
+
+    credit = DuodealerAPI::ApplicationCredit.find(803742)
+
+    assert_equal 'refund for application charge', credit.description
+    assert_equal '5.00', credit.amount
+  end
+
+  def test_list_application_credits
+    fake "application_credits", method: :get, status: 201, body: load_fixture('application_credits')
+
+    credit = DuodealerAPI::ApplicationCredit.find(:all)
+
+    assert_equal 2, credit.size
+    assert_equal '10.00', credit.last.amount
+  end
+end

data/test/article_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+class ArticleTest < Test::Unit::TestCase
+
+  def test_create_article
+    fake "blogs/1008414260/articles", :method => :post, :body => load_fixture('article')
+    article = DuodealerAPI::Article.new(:blog_id => 1008414260)
+    article.save
+    assert_equal "First Post", article.title
+  end
+
+  def test_get_article
+    fake "articles/6242736", :method => :get, :body => load_fixture('article')
+    article = DuodealerAPI::Article.find(6242736)
+    assert_equal "First Post", article.title
+    assert_equal 1008414260, article.blog_id
+  end
+
+  def test_get_articles
+    fake "articles", :method => :get, :body => load_fixture('articles')
+    articles = DuodealerAPI::Article.all
+    assert_equal 3, articles.length
+    assert_equal 1008414260, articles.first.blog_id
+  end
+
+  def test_get_articles_namespaced
+    fake "blogs/1008414260/articles", :method => :get, :body => load_fixture('articles')
+    articles = DuodealerAPI::Article.find(:all, :params => {:blog_id => 1008414260})
+    assert_equal 3, articles.length
+    assert_equal 1008414260, articles.first.blog_id
+  end
+
+  def test_get_article_namespaced
+    fake "blogs/1008414260/articles/6242736", :method => :get, :body => load_fixture('article')
+    article = DuodealerAPI::Article.find(6242736, :params => {:blog_id => 1008414260})
+    assert_equal "First Post", article.title
+    assert_equal 1008414260, article.blog_id
+  end
+
+  def test_get_authors
+    fake "articles/authors", :method => :get, :body => load_fixture('authors')
+    authors = DuodealerAPI::Article.authors
+    assert_equal "Duodealer", authors.first
+    assert_equal "development shop", authors.last
+  end
+
+  def test_get_authors_for_blog_id
+    fake "blogs/1008414260/articles/authors", :method => :get, :body => load_fixture('authors')
+    authors = DuodealerAPI::Article.authors(:blog_id => 1008414260)
+    assert_equal 3, authors.length
+  end
+
+  def test_get_tags
+    fake "articles/tags", :method => :get, :body => load_fixture('tags')
+    tags = DuodealerAPI::Article.tags
+    assert_equal "consequuntur", tags.first
+    assert_equal "repellendus", tags.last
+  end
+
+  def test_get_tags_for_blog_id
+    fake "blogs/1008414260/articles/tags", :method => :get, :body => load_fixture('tags')
+    tags = DuodealerAPI::Article.tags(:blog_id => 1008414260)
+    assert_equal "consequuntur", tags.first
+    assert_equal "repellendus", tags.last
+  end
+
+  def test_get_popular_tags
+    fake "articles/tags.json?limit=1&popular=1", :extension => false, :method => :get, :body => load_fixture('tags')
+    tags = DuodealerAPI::Article.tags(:popular => 1, :limit => 1)
+    assert_equal 3, tags.length
+  end
+
+end

data/test/asset_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class AssetTest < Test::Unit::TestCase
+  def test_get_assetss
+    fake "themes/1/assets", :method => :get, :body => load_fixture('assets')
+    v = DuodealerAPI::Asset.find(:all, :params => {:theme_id => 1})
+  end
+
+  def test_get_asset_namespaced
+    fake "themes/1/assets.json?asset%5Bkey%5D=templates%2Findex.liquid&theme_id=1", :extension=> false, :method => :get, :body => load_fixture('asset')
+    v = DuodealerAPI::Asset.find('templates/index.liquid', :params => {:theme_id => 1})
+  end
+
+  def test_get_asset
+    fake "assets.json?asset%5Bkey%5D=templates%2Findex.liquid", :extension=> false, :method => :get, :body => load_fixture('asset')
+    v = DuodealerAPI::Asset.find('templates/index.liquid')
+  end
+end

data/test/assigned_fulfillment_order_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+require 'fulfillment_order_test_helper'
+
+class AssignedFulFillmentOrderTest < Test::Unit::TestCase
+  include FulfillmentOrderTestHelper
+
+  def setup
+    super
+    @url_prefix = url_prefix_for_activated_session_for('2020-01')
+    @fulfillment_order_fixture = load_fixture('assigned_fulfillment_orders')
+  end
+
+  context "AssignedFulfillmentOrder" do
+    context ".new" do
+      should "raise NotImplementedError when api_version is older than 2020-01" do
+        url_prefix_for_activated_session_for('2019-10')
+
+        assert_raises NotImplementedError do
+          DuodealerAPI::AssignedFulfillmentOrder.new(ActiveSupport::JSON.decode(@fulfillment_order_fixture))
+        end
+      end
+    end
+
+    context "#all" do
+      should "raise NotImplementedError when api_version is older than 2020-01" do
+        @url_prefix = url_prefix_for_activated_session_for('2019-10')
+
+        fake 'assigned_fulfillment_orders',
+          url: "#{@url_prefix}/assigned_fulfillment_orders.json",
+          method: :get,
+          body: @fulfillment_order_fixture,
+          extension: false
+
+        assert_raises NotImplementedError do
+          DuodealerAPI::AssignedFulfillmentOrder.all(params: { assigned_status: 'cancellation_requested' })
+        end
+      end
+
+      should "list assigned fulfillment orders by assigned_status" do
+        fake 'assigned_fulfillment_orders',
+          url: "#{@url_prefix}/assigned_fulfillment_orders.json?assigned_status=cancellation_requested",
+          method: :get,
+          body: @fulfillment_order_fixture,
+          extension: false
+
+        assigned_fulfillment_orders = DuodealerAPI::AssignedFulfillmentOrder.all(
+            params: { assigned_status: 'cancellation_requested' }
+        )
+
+        assert_equal 2, assigned_fulfillment_orders.count
+        assigned_fulfillment_orders.each do |fulfillment_order|
+          assert fulfillment_order.is_a?(DuodealerAPI::FulfillmentOrder)
+          assert_equal 'in_progress', fulfillment_order.status
+          assert_equal 'cancellation_accepted', fulfillment_order.request_status
+        end
+      end
+
+      should "be able to list assigned fulfillment orders by location_ids" do
+        assigned_location_id = 905684977
+        fake 'assigned_fulfillment_orders',
+          url: "#{@url_prefix}/assigned_fulfillment_orders.json?location_ids%5B%5D=#{assigned_location_id}",
+          method: :get,
+          body: @fulfillment_order_fixture, extension: false
+
+        assigned_fulfillment_orders = DuodealerAPI::AssignedFulfillmentOrder.all(
+            params: { location_ids: [assigned_location_id] }
+        )
+
+        assert_equal 2, assigned_fulfillment_orders.count
+        assigned_fulfillment_orders.each do |fulfillment_order|
+          assert fulfillment_order.is_a?(DuodealerAPI::FulfillmentOrder)
+          assert_equal assigned_location_id, fulfillment_order.assigned_location_id
+        end
+      end
+    end
+  end
+end

data/test/base_test.rb

@@ -0,0 +1,198 @@
+require 'test_helper'
+require "active_support/log_subscriber/test_helper"
+
+class BaseTest < Test::Unit::TestCase
+  def setup
+    super
+    @session1 = DuodealerAPI::Session.new(domain: 'shop1.duodealer.com', token: 'token1', api_version: '2019-01')
+    @session2 = DuodealerAPI::Session.new(domain: 'shop2.duodealer.com', token: 'token2', api_version: '2019-01')
+  end
+
+  def teardown
+    super
+    clear_header('X-Custom')
+  end
+
+  test '#activate_session should set site and headers for given session' do
+    DuodealerAPI::Base.activate_session @session1
+
+    assert_nil ActiveResource::Base.site
+    assert_equal 'https://shop1.duodealer.com', DuodealerAPI::Base.site.to_s
+    assert_equal 'https://shop1.duodealer.com', DuodealerAPI::Shop.site.to_s
+
+    assert_nil ActiveResource::Base.headers['X-DuoDealer-Access-Token']
+    assert_equal 'token1', DuodealerAPI::Base.headers['X-DuoDealer-Access-Token']
+    assert_equal 'token1', DuodealerAPI::Shop.headers['X-DuoDealer-Access-Token']
+  end
+
+  test '#clear_session should clear base site settings from Base' do
+    DuodealerAPI::Base.site = "https://foo:bar@www.zombo.com"
+
+    assert_equal "foo", DuodealerAPI::Base.user
+    assert_equal "bar", DuodealerAPI::Base.password
+
+    DuodealerAPI::Base.clear_session
+
+    assert_nil DuodealerAPI::Base.user
+    assert_nil DuodealerAPI::Base.password
+    assert_nil DuodealerAPI::Base.site
+  end
+
+  test '#clear_session should clear site and headers from Base' do
+    DuodealerAPI::Base.activate_session @session1
+    DuodealerAPI::Base.clear_session
+
+    assert_nil ActiveResource::Base.site
+    assert_nil DuodealerAPI::Base.site
+    assert_nil DuodealerAPI::Shop.site
+
+    assert_nil ActiveResource::Base.headers['X-DuoDealer-Access-Token']
+    assert_nil DuodealerAPI::Base.headers['X-DuoDealer-Access-Token']
+    assert_nil DuodealerAPI::Shop.headers['X-DuoDealer-Access-Token']
+  end
+
+  test '#activate_session with one session, then clearing and activating with another session should send request to correct shop' do
+    DuodealerAPI::Base.activate_session @session1
+    DuodealerAPI::Base.clear_session
+    DuodealerAPI::Base.activate_session @session2
+
+    assert_nil ActiveResource::Base.site
+    assert_equal 'https://shop2.duodealer.com', DuodealerAPI::Base.site.to_s
+    assert_equal 'https://shop2.duodealer.com', DuodealerAPI::Shop.site.to_s
+
+    assert_nil ActiveResource::Base.headers['X-DuoDealer-Access-Token']
+    assert_equal 'token2', DuodealerAPI::Base.headers['X-DuoDealer-Access-Token']
+    assert_equal 'token2', DuodealerAPI::Shop.headers['X-DuoDealer-Access-Token']
+  end
+
+  test '#activate_session with nil raises an InvalidSessionError' do
+    assert_raises DuodealerAPI::Base::InvalidSessionError do
+      DuodealerAPI::Base.activate_session nil
+    end
+  end
+
+  test "#delete should send custom headers with request" do
+    DuodealerAPI::Base.activate_session @session1
+    DuodealerAPI::Base.headers['X-Custom'] = 'abc'
+    DuodealerAPI::Base.connection
+      .expects(:delete)
+      .with('/admin/api/2019-01/bases/1.json', has_entry('X-Custom', 'abc'))
+    DuodealerAPI::Base.delete "1"
+  end
+
+  test "#headers includes the User-Agent" do
+    assert_not_includes ActiveResource::Base.headers.keys, 'User-Agent'
+    assert_includes DuodealerAPI::Base.headers.keys, 'User-Agent'
+    thread = Thread.new do
+      assert_includes DuodealerAPI::Base.headers.keys, 'User-Agent'
+    end
+    thread.join
+  end
+
+  test "prefix= will forward to resource when the value does not start with admin" do
+    session = DuodealerAPI::Session.new(domain: 'shop1.duodealer.com', token: 'token1', api_version: '2019-01')
+    DuodealerAPI::Base.activate_session(session)
+    silence_warnings do
+      TestResource.prefix = 'a/regular/path/'
+    end
+
+    assert_equal('/admin/api/2019-01/a/regular/path/', TestResource.prefix)
+  end
+
+  test "prefix= will raise an error if value starts with with /admin" do
+    assert_raises ArgumentError do
+      TestResource.prefix = '/admin/old/prefix/structure/'
+    end
+  end
+
+  test "#headers propagates changes to subclasses" do
+    DuodealerAPI::Base.headers['X-Custom'] = "the value"
+    assert_equal "the value", DuodealerAPI::Base.headers['X-Custom']
+    assert_equal "the value", DuodealerAPI::Product.headers['X-Custom']
+  end
+
+  test "#headers clears changes to subclasses" do
+    DuodealerAPI::Base.headers['X-Custom'] = "the value"
+    assert_equal "the value", DuodealerAPI::Product.headers['X-Custom']
+    DuodealerAPI::Base.headers['X-Custom'] = nil
+    assert_nil DuodealerAPI::Product.headers['X-Custom']
+  end
+
+  test "#headers set in the main thread affect spawned threads" do
+    DuodealerAPI::Base.headers['X-Custom'] = "the value"
+    Thread.new do
+      assert_equal "the value", DuodealerAPI::Base.headers['X-Custom']
+    end.join
+  end
+
+  test "#headers set in spawned threads do not affect the main thread" do
+    Thread.new do
+      DuodealerAPI::Base.headers['X-Custom'] = "the value"
+    end.join
+    assert_nil DuodealerAPI::Base.headers['X-Custom']
+  end
+
+  test "using a different version changes the url" do
+    release_2019_01 = DuodealerAPI::Session.new(domain: 'shop1.duodealer.com', token: 'token1', api_version: '2019-01')
+    unstable_version = DuodealerAPI::Session.new(domain: 'shop2.duodealer.com', token: 'token2', api_version: :unstable)
+
+    fake(
+      "shop",
+      url: "https://shop1.duodealer.com/admin/api/2019-01/shop.json",
+      method: :get,
+      status: 201,
+      body: '{ "shop": { "id": 1 } }'
+    )
+    fake(
+      "shop",
+      url: "https://shop2.duodealer.com/admin/api/unstable/shop.json",
+      method: :get,
+      status: 201,
+      body: '{ "shop": { "id": 2 } }'
+    )
+
+    DuodealerAPI::Base.activate_session(release_2019_01)
+    assert_equal 1, DuodealerAPI::Shop.current.id
+
+    DuodealerAPI::Base.activate_session(unstable_version)
+    assert_equal 2, DuodealerAPI::Shop.current.id
+  end
+
+  test "#api_version= should set ApiVersion" do
+    DuodealerAPI::Base.api_version = '2019-04'
+    assert_equal '2019-04', DuodealerAPI::Base.api_version.to_s
+  end
+
+  test "#api_version= nil should set ApiVersion to DuodealerAPI::ApiVersion::NullVersion" do
+    DuodealerAPI::Base.api_version = nil
+    assert_equal DuodealerAPI::ApiVersion::NullVersion, DuodealerAPI::Base.api_version
+  end
+
+  test "#api_version= DuodealerAPI::ApiVersion::NullVersion should set ApiVersion to DuodealerAPI::ApiVersion::NullVersion" do
+    DuodealerAPI::Base.api_version = DuodealerAPI::ApiVersion::NullVersion
+    assert_equal DuodealerAPI::ApiVersion::NullVersion, DuodealerAPI::Base.api_version
+  end
+
+  test "#version_validation! does not raise is api_version is newer or equal to minimum supported version" do
+    DuodealerAPI::Base.api_version = '2020-01'
+    assert_nil DuodealerAPI::Base::version_validation!('2020-01')
+  end
+
+  test "#version_validation! raises NotImplemetedError if api_version is older than minimum supported version" do
+    DuodealerAPI::Base.api_version = '2019-10'
+    exception = assert_raises NotImplementedError do
+      DuodealerAPI::Base::version_validation!('2020-01')
+    end
+    assert_equal 'The minimum supported version is 2020-01.', exception.message
+  end
+
+
+  def clear_header(header)
+    [ActiveResource::Base, DuodealerAPI::Base, DuodealerAPI::Product].each do |klass|
+      klass.headers.delete(header)
+    end
+  end
+
+  class TestResource < DuodealerAPI::Base
+  end
+end