ecwid_api 0.0.2 → 0.1.0

data/spec/helpers/client.rb

@@ -0,0 +1,32 @@
+module Helpers
+  module Client
+    def client
+      @client ||= EcwidApi::Client.new(12345, "access_token").tap do |client|
+        allow(client).to receive(:connection).and_return(faraday)
+      end
+    end
+
+    def fixtures
+      %w(categories category orders products)
+    end
+
+    def faraday_stubs
+      ::Faraday::Adapter::Test::Stubs.new do |stub|
+        fixtures.each do |fixture|
+          stub.get(fixture) { [ 200, {"Content-Type" => "application/json"}, File.read("spec/fixtures/#{fixture}.json") ] }
+        end
+        stub.get("/categories/5") { [200, {"Content-Type" => "application/json"}, File.read("spec/fixtures/category.json") ] }
+        stub.get("/orders/35") { [200, {"Content-Type" => "application/json"}, File.read("spec/fixtures/order.json") ] }
+        stub.get("/orders/404") { [404, {"Content-Type" => "application/json"}, nil ] }
+      end
+    end
+
+    # Public: Returns a test Faraday::Connection
+    def faraday
+      ::Faraday.new do |builder|
+        builder.response :json, content_type: /\bjson$/
+        builder.adapter :test, faraday_stubs
+      end
+    end
+  end
+end

data/spec/oauth_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe EcwidApi::OAuth do
+  subject do
+    EcwidApi::OAuth.new do |config|
+      config.client_id = "client_id"
+      config.client_secret = "client_secret"
+      config.scope = "scope"
+      config.redirect_uri = "https://example.com/oauth"
+    end
+  end
+
+  its(:oauth_url) { should == "https://my.ecwid.com/api/oauth/authorize?client_id=client_id&scope=scope&response_type=code&redirect_uri=https%3A%2F%2Fexample.com%2Foauth" }
+
+  describe "#access_token(code)" do
+    let(:response) do
+      double("response").tap do |response|
+        allow(response).to receive(:success?).and_return(true)
+        allow(response).to receive(:body).and_return(access_token: "the_token", store_id: "12345")
+      end
+    end
+
+    before(:each) do
+      allow(subject.send(:connection)).to receive(:post).with("/api/oauth/token", hash_including(code: "code")).and_return(response)
+    end
+
+    it "sends a request to the API for an access_token" do
+      expect(subject.send(:connection)).to receive(:post).with("/api/oauth/token", hash_including(code: "code")).and_return(response)
+      subject.access_token("code")
+    end
+
+    it "returns an object that has the access_token" do
+      subject.access_token("code").access_token.should == "the_token"
+    end
+
+    it "returns an object that has the store_id" do
+      subject.access_token("code").store_id.should == "12345"
+    end
+  end
+end

data/spec/order_item_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe EcwidApi::OrderItem do
+  subject { EcwidApi::OrderItem.new({"sku" => "12345", "categoryId" => 222}, client: client) }
+
+  describe "#category" do
+    it "gets the category from the client" do
+      expect(client.categories).to receive(:find).with(222)
+      subject.category
+    end
+  end
+end

data/spec/order_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe EcwidApi::Order, faraday: true do
+  subject do
+    EcwidApi::Order.new({
+      "orderNumber" => 123,
+      "billingPerson" => {
+        "name" => "John Doe"
+      },
+      "shippingPerson" => shipping_person,
+      "items" => [{
+        "sku" => "112233"
+      }],
+      "fulfillmentStatus" => "AWAITING_PROCESSING"
+    })
+  end
+
+  let(:shipping_person) { nil }
+
+  its(:id) { should == 123 }
+
+  describe "#billing_person" do
+    its(:billing_person) { should be_a(EcwidApi::Person) }
+
+    it "has the correct data" do
+      subject.billing_person.name.should == "John Doe"
+    end
+  end
+
+  describe "#shipping_person" do
+    its(:shipping_person) { should be_a(EcwidApi::Person) }
+
+    context "without a shipping person" do
+      let(:shipping_person) { nil }
+      its(:shipping_person) { should == subject.billing_person }
+    end
+
+    context "with a shipping person" do
+      let(:shipping_person) { {"name" => "Jane Doe"} }
+      it "has the correct data" do
+        subject.shipping_person.name.should == "Jane Doe"
+      end
+    end
+  end
+
+  describe "#items" do
+    it "has the correct number of items" do
+      subject.items.size.should == 1
+    end
+
+    it "has the correct data" do
+      subject.items.first.sku.should == "112233"
+    end
+  end
+
+  describe "#fulfillment_status=" do
+    it "raises an error with an invalid status" do
+      expect { subject.fulfillment_status = :stuff }.to raise_error
+    end
+
+    it "doesn't raise an error with a valid status" do
+      expect { subject.fulfillment_status = :processing }.to_not raise_error
+    end
+  end
+
+  describe "#fulfillment_status" do
+    it "is symbolized" do
+      subject.fulfillment_status.should == :awaiting_processing
+    end
+  end
+end

data/spec/paged_enumerator_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe EcwidApi::PagedEnumerator do
+  subject do
+    EcwidApi::PagedEnumerator.new(response_one, &proc)
+  end
+
+  let(:proc) do
+    Proc.new do |response, yielder|
+      response[:stuff].each { |thing| yielder << thing }
+      response[:next]
+    end
+  end
+
+  let(:response_one) do
+    {
+      stuff: %w(1 2 3),
+      next: response_two
+    }
+  end
+
+  let(:response_two) do
+    {
+      stuff: %w(4 5 6),
+    }
+  end
+
+  it "contains the whole result set" do
+    subject.to_a.should == %w(1 2 3 4 5 6)
+  end
+
+  it "iterates over each response once" do
+    expect(response_two[:stuff]).to receive(:each).once.and_call_original
+
+    subject.each
+    subject.each
+  end
+end

data/spec/spec_helper.rb

@@ -1,23 +1,24 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-
-require "ecwid_api"
-require "helpers/faraday"
-
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
-  config.include Helpers::Faraday, faraday: true
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
-end
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "ecwid_api"
+require "helpers/client"
+require "pry"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.include Helpers::Client
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecwid_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - David Biehl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
@@ -89,27 +103,49 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - ecwid_api.gemspec
 - lib/ecwid_api.rb
+- lib/ecwid_api/api.rb
+- lib/ecwid_api/api/base.rb
+- lib/ecwid_api/api/categories.rb
+- lib/ecwid_api/api/orders.rb
+- lib/ecwid_api/api/product_combinations.rb
+- lib/ecwid_api/api/products.rb
 - lib/ecwid_api/category.rb
-- lib/ecwid_api/category_api.rb
 - lib/ecwid_api/client.rb
 - lib/ecwid_api/entity.rb
 - lib/ecwid_api/error.rb
+- lib/ecwid_api/o_auth.rb
+- lib/ecwid_api/order.rb
+- lib/ecwid_api/order_item.rb
+- lib/ecwid_api/paged_ecwid_response.rb
+- lib/ecwid_api/paged_enumerator.rb
+- lib/ecwid_api/person.rb
+- lib/ecwid_api/product.rb
+- lib/ecwid_api/product_combination.rb
 - lib/ecwid_api/version.rb
 - lib/ext/string.rb
-- spec/category_api_spec.rb
+- spec/api/categories_spec.rb
+- spec/api/orders_spec.rb
+- spec/api/products_spec.rb
 - spec/category_spec.rb
 - spec/client_spec.rb
-- spec/ecwid_api_spec.rb
 - spec/entity_spec.rb
 - spec/fixtures/categories.json
 - spec/fixtures/category.json
-- spec/helpers/faraday.rb
+- spec/fixtures/order.json
+- spec/fixtures/orders.json
+- spec/fixtures/products.json
+- spec/helpers/client.rb
+- spec/oauth_spec.rb
+- spec/order_item_spec.rb
+- spec/order_spec.rb
+- spec/paged_enumerator_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -136,12 +172,20 @@ signing_key:
 specification_version: 4
 summary: A client for the Ecwid REST API
 test_files:
-- spec/category_api_spec.rb
+- spec/api/categories_spec.rb
+- spec/api/orders_spec.rb
+- spec/api/products_spec.rb
 - spec/category_spec.rb
 - spec/client_spec.rb
-- spec/ecwid_api_spec.rb
 - spec/entity_spec.rb
 - spec/fixtures/categories.json
 - spec/fixtures/category.json
-- spec/helpers/faraday.rb
+- spec/fixtures/order.json
+- spec/fixtures/orders.json
+- spec/fixtures/products.json
+- spec/helpers/client.rb
+- spec/oauth_spec.rb
+- spec/order_item_spec.rb
+- spec/order_spec.rb
+- spec/paged_enumerator_spec.rb
 - spec/spec_helper.rb

data/lib/ecwid_api/category_api.rb

@@ -1,62 +0,0 @@
-module EcwidApi
-  # Public: This is the Ecwid API for Categories. It abstracts the end-points
-  # of the Ecwid API that deal with categories.
-  class CategoryApi
-    # Private: Gets the Client
-    attr_reader :client
-    private :client
-
-    # Public: Initializes a new EcwidApi::CategoryApi
-    #
-    # client - The EcwidApi::Client to use with the API
-    #
-    def initialize(client = EcwidApi.default_client)
-      @client = client
-      raise Error.new("The client cannot be nil") unless client
-    end
-
-    # Public: Returns all of the sub-categories for a given category
-    #
-    # See: http://kb.ecwid.com/w/page/25285101/Product%20API#RESTAPIMethodcategories
-    #
-    # parent - The Category ID of the parent category. If the parent is 0 then
-    #          a list of the root categories will be returned. If the parent is
-    #          nil, then all of the categories will be returned
-    #
-    # Returns an array of EcwidApi::Category objects
-    def all(parent = nil)
-      params = {}
-      params[:parent] = parent if parent
-
-      response = client.get("categories", params)
-
-      if response.success?
-        response.body
-      else
-        []
-      end.map {|category| Category.new(category, client: client) }
-    end
-
-    # Public: Returns an Array of the root level EcwidApi::Category objects
-    def root
-      all(0)
-    end
-
-    # Public: Returns a single EcwidApi::Category
-    #
-    # See: http://kb.ecwid.com/w/page/25285101/Product%20API#RESTAPIMethodcategory
-    #
-    # category_id - A Category ID to get
-    #
-    # Returns an EcwidApi::Category, or nil if it can't be found
-    def find(category_id)
-      response = client.get("category", id: category_id)
-
-      if response.success?
-        Category.new(response.body, client: client)
-      else
-        nil
-      end
-    end
-  end
-end

data/spec/category_api_spec.rb

@@ -1,36 +0,0 @@
-require 'spec_helper'
-
-describe EcwidApi::CategoryApi, faraday: true do
-  let(:client) { EcwidApi::Client.new { |config| config.store_id = '12345' } }
-  subject { EcwidApi::CategoryApi.new(client) }
-
-  before(:each) do
-    faraday_client(client)
-  end
-
-  describe "#all" do
-    it "gets all of the categories from the client" do
-      expect(client).to receive(:get).with("categories", {}).and_call_original
-      subject.all
-    end
-
-    it "gets sub categories" do
-      expect(client).to receive(:get).with("categories", parent: 5).and_call_original
-      subject.all(5)
-    end
-  end
-
-  describe "#root" do
-    it "gets the root level categories" do
-      expect(subject).to receive(:all).with(0).and_call_original
-      subject.root
-    end
-  end
-
-  describe "#find" do
-    it "finds a single category" do
-      expect(client).to receive(:get).with("category", id: 5).and_call_original
-      subject.find(5)
-    end
-  end
-end

data/spec/ecwid_api_spec.rb

@@ -1,15 +0,0 @@
-require 'spec_helper'
-
-describe EcwidApi do
-  describe "::default_client" do
-    it "builds an EcwidApi::Client with the block" do
-      EcwidApi.default_client.should be_nil
-
-      client = EcwidApi.default_client do |config|
-        config.store_id = 123
-      end
-
-      client.is_a?(EcwidApi::Client).should be_true
-    end
-  end
-end

data/spec/helpers/faraday.rb

@@ -1,30 +0,0 @@
-require 'faraday'
-
-module Helpers
-  module Faraday
-    def fixtures
-      %w(categories category)
-    end
-
-    def faraday_stubs
-      ::Faraday::Adapter::Test::Stubs.new do |stub|
-        fixtures.each do |fixture|
-          stub.get(fixture) { [ 200, {"Content-Type" => "application/json"}, File.read("spec/fixtures/#{fixture}.json") ] }
-        end
-      end
-    end
-
-    # Public: Returns a test Faraday::Connection
-    def faraday
-      ::Faraday.new do |builder|
-        builder.response :json, content_type: /\bjson$/
-        builder.adapter :test, faraday_stubs
-      end
-    end
-
-    # Public: Uses the Faraday stub connection with the client
-    def faraday_client(client)
-      allow(client).to receive(:connection).and_return(faraday)
-    end
-  end
-end