ecwid_api 0.2.2 → 0.2.3

data/lib/ecwid_api/error.rb

@@ -4,7 +4,7 @@ module EcwidApi
   class ResponseError < Error
     def initialize(response)
       if response.respond_to?(:reason_phrase)
-        super("#{response.reason_phrase} (#{response.status})")
+        super "#{response.reason_phrase} (#{response.status})\n#{response.body}"
       else
         super "The Ecwid API responded with an error (#{response.status})"
       end

data/lib/ecwid_api/order.rb

@@ -3,7 +3,7 @@ module EcwidApi
   class Order < Entity
     self.url_root = "orders"
 
-    ecwid_reader :orderNumber, :vendorOrderNumber, :subtotal, :total, :email,
+    ecwid_reader :id, :orderNumber, :vendorOrderNumber, :subtotal, :total, :email,
                  :paymentMethod, :paymentModule, :tax, :ipAddress,
                  :couponDiscount, :paymentStatus, :fulfillmentStatus,
                  :refererUrl, :orderComments, :volumeDiscount, :customerId,
@@ -13,7 +13,7 @@ module EcwidApi
                  :shippingPerson, :shippingOption, :additionalInfo,
                  :paymentParams, :discountInfo, :trackingNumber,
                  :paymentMessage, :extTransactionId, :affiliateId,
-                 :creditCardStatus
+                 :creditCardStatus, :handlingFee
 
 
     ecwid_writer :subtotal, :total, :email, :paymentMethod, :paymentModule,
@@ -25,7 +25,7 @@ module EcwidApi
                  :items, :billingPerson, :shippingPerson, :shippingOption,
                  :additionalInfo, :paymentParams, :discountInfo,
                  :trackingNumber, :paymentMessage, :extTransactionId,
-                 :affiliateId, :creditCardStatus
+                 :affiliateId, :creditCardStatus, :handlingFee
 
     VALID_FULFILLMENT_STATUSES = %w(
       AWAITING_PROCESSING
@@ -34,11 +34,29 @@ module EcwidApi
       DELIVERED
       WILL_NOT_DELIVER
       RETURNED
-    )
+      READY_FOR_PICKUP
+      OUT_FOR_DELIVERY
+    ).freeze
 
-    # Public: Gets the unique ID of the order
-    def id
-      order_number
+    VALID_PAYMENT_STATUSES = %w(
+      AWAITING_PAYMENT
+      PAID
+      CANCELLED
+      REFUNDED
+      PARTIALLY_REFUNDED
+      INCOMPLETE
+    ).freeze
+
+    # @deprecated Please use {#id} instead
+    def vendor_order_number
+      warn "[DEPRECATION] `vendor_order_number` is deprecated.  Please use `id` instead."
+      id
+    end
+
+    # @deprecated Please use {#id} instead
+    def order_number
+      warn "[DEPRECATION] `order_number` is deprecated.  Please use `id` instead."
+      id
     end
 
     # Public: Returns the billing person
@@ -51,7 +69,7 @@ module EcwidApi
 
     # Public: Returns the shipping person
     #
-    # If there isn't a shipping_person, then it is assumed to be the 
+    # If there isn't a shipping_person, then it is assumed to be the
     # billing_person
     #
     def shipping_person
@@ -75,6 +93,18 @@ module EcwidApi
       super && super.downcase.to_sym
     end
 
+    def payment_status=(status)
+      status = status.to_s.upcase
+      unless VALID_PAYMENT_STATUSES.include?(status)
+        raise Error("#{status} is an invalid payment status")
+      end
+      super(status)
+    end
+
+    def payment_status
+      super && super.downcase.to_sym
+    end
+
     private
 
     def build_billing_person
@@ -85,4 +115,4 @@ module EcwidApi
       @shipping_person ||= data["shippingPerson"] && Person.new(data["shippingPerson"])
     end
   end
-end
+end

data/lib/ecwid_api/paged_ecwid_response.rb

@@ -1,4 +1,4 @@
-require_relative "paged_enumerator"
+require_relative 'paged_enumerator'
 
 # Public: Presents a paged Ecwid response as an Enumerator with a
 # PagedEnumerator
@@ -31,20 +31,22 @@ module EcwidApi
       params[:limit] = 100
       params.delete(:offset)
 
-      block ||= Proc.new { |item| item }
+      block ||= proc { |item| item }
 
       response = client.get(path, params)
 
-      @paged_enumerator = PagedEnumerator.new(response) do |response, yielder|
-        response.body["items"].each do |item|
-          yielder << block.call(item)
+      @paged_enumerator = PagedEnumerator.new(response) do |enum_response, yielder|
+        count, offset, total = %w[count offset total].map do |i|
+          enum_response.body[i].to_i
         end
 
-        count, offset, total = %w(count offset total).map do |i|
-          response.body[i].to_i
+        if count > 0
+          enum_response.body['items'].each do |item|
+            yielder << block.call(item)
+          end
         end
 
-        if count == 0 || count + offset >= total
+        if count.zero? || count + offset >= total
           false
         else
           client.get(path, params.merge(offset: offset + count))
@@ -52,4 +54,4 @@ module EcwidApi
       end
     end
   end
-end
+end

data/lib/ecwid_api/product_type.rb

@@ -0,0 +1,18 @@
+module EcwidApi
+  class ProductType < Entity
+
+     self.url_root = "classes"
+
+     ecwid_reader :id, :name, :googleTaxonomy, :attributes
+
+     ecwid_writer :name, :attributes
+
+
+     # Public: Returns a Array of `ProductTypeAttribute` objects
+    def attributes
+      @attributes ||= data["attributes"].map { |attribute| ProductTypeAttribute.new(attribute) }
+    end
+
+
+   end
+end

data/lib/ecwid_api/product_type_attribute.rb

@@ -0,0 +1,27 @@
+module EcwidApi
+  class ProductTypeAttribute < Entity
+
+    ecwid_reader :id, :name, :type, :show
+
+    VALID_TYPES = %w(CUSTOM UPC BRAND GENDER AGE_GROUP COLOR SIZE PRICE_PER_UNIT UNITS_IN_PRODUCT)
+    VALID_SHOWS = %w(NOTSHOW DESCR PRICE)
+
+
+    def type=(type_type)
+      type_type = type_type.to_s.upcase
+      unless VALID_TYPES.include?(type_type)
+        raise ::StandardError.new("#{type_type} is an invalid 'type'")
+      end
+      super(type_type)
+    end
+
+
+     def show=(show_type)
+      show_type = show_type.to_s.upcase
+      unless VALID_SHOWS.include?(show_type)
+        raise ::StandardError.new("#{show_type} is an invalid 'show'")
+      end
+      super(show_type)
+    end
+  end
+end

data/lib/ecwid_api/unpaged_ecwid_response.rb

@@ -0,0 +1,38 @@
+
+ # Public: Presents an Ecwid response as an Array
+#
+# Example
+#
+#   response = UnpagedEcwidResponse.new(client, "products", priceFrom: 10) do |product_hash|
+#     Product.new(product_hash, click: client)
+#   end
+#
+#   response.each do |product|
+#     # do stuff the the product
+#   end
+#
+module EcwidApi
+  class UnpagedEcwidResponse
+    include Enumerable
+    extend  Forwardable
+
+     def_delegators :@records, *Enumerable.instance_methods
+
+     # Public: Initialize a new UnpagedEcwidResponse
+    #
+    # client - an EcwidApi::Client
+    # path   - a String that is the path to retrieve from the client
+    # params - a Hash of parameters to pass along with the request
+    # &block - a Block that processes each item returned in the Response
+    #
+    def initialize(client, path, params = {}, &block)
+      block ||= Proc.new { |item| item }
+      @records = []
+
+       response = client.get(path, params)
+      response.body.each do |item|
+        @records << block.call(item)
+      end
+    end
+  end
+end

data/lib/ecwid_api/version.rb

@@ -1,3 +1,3 @@
 module EcwidApi
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/api/customers_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+ describe EcwidApi::Api::Customers, faraday: true do
+  subject { client.customers }
+
+   describe "#all" do
+    it "passes any other parameters through" do
+      expect(client).to receive(:get).with("customers", hash_including(from_date: '1982-05-17'))
+      subject.all(from_date: '1982-05-17')
+    end
+
+     it "gets the proper response count (see fixture)" do
+      expect(subject.all.count).to eq 5
+    end
+
+     it "gets the proper customer (see fixture)" do
+      expect(subject.all.first.name).to eq "Abe Doe"
+    end
+  end
+end

data/spec/api/orders_spec.rb

@@ -10,21 +10,21 @@ describe EcwidApi::Api::Orders, faraday: true do
     end
 
     it "gets the proper response (see fixtures)" do
-      subject.all.count.should == 2
+      expect(subject.all.count).to be 2
     end
 
     it "gets EcwidApi::Order types" do
-      subject.all.all? { |order| order.is_a?(EcwidApi::Order) }.should be_true
+      expect(subject.all.all? { |order| order.is_a?(EcwidApi::Order) }).to be(true)
     end
   end
 
   describe "#find" do
     it "is an `EcwidApi::Order`" do
-      subject.find(35).is_a?(EcwidApi::Order).should be_true
+      expect(subject.find(35)).to be_a(EcwidApi::Order)
     end
 
     it "is nil when not found" do
-      subject.find(404).should be_nil
+      expect(subject.find(404)).to be_nil
     end
   end
-end
+end

data/spec/api/product_types_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+ describe EcwidApi::Api::ProductTypes, faraday: true do
+  subject { client.product_types }
+
+   describe "#all" do
+    it "returns an array" do
+      expect(client).to receive(:get).with("classes", {}).and_call_original
+      subject.all
+    end
+
+     it "gets the proper response count (see fixture)" do
+      expect(subject.all.count).to eq 2
+    end
+
+     it "gets the proper product_type (see fixture)" do
+      expect(subject.all.first.name).to eq "Foo"
+    end
+  end
+end

data/spec/client_spec.rb

@@ -4,7 +4,7 @@ describe EcwidApi::Client do
   subject { client }
 
   describe "#store_url" do
-    its(:store_url) { "http://app.ecwid.com/api/v3/12345" }
+    it { is_expected.to have_attributes(store_url: "https://app.ecwid.com/api/v3/12345") }
   end
 
   describe "#get", faraday: true do
@@ -15,7 +15,7 @@ describe EcwidApi::Client do
     end
 
     it "returns a Faraday::Response" do
-      subject.get("categories", parent: 1).is_a?(Faraday::Response).should be_true
+      expect(subject.get("categories", parent: 1)).to be_a(Faraday::Response)
     end
   end
-end
+end

data/spec/entity_spec.rb

@@ -34,42 +34,50 @@ describe EcwidApi::Entity do
   subject { EntitySubject.new(data) }
 
   describe "::url_root" do
-    its(:url) { should == "stuff/123" }
+    it { is_expected.to have_attributes(url: "stuff/123") }
 
     context "with a proc" do
       subject { EntityUrlSubject.new(data) }
-      its(:url) { should == "parent/456/and/123" }
+      it { is_expected.to have_attributes(url: "parent/456/and/123") }
     end
   end
 
-
   describe "#[]" do
     it "gets data with a symbol key" do
-      subject[:id].should == 123
+      expect(subject[:id]).to eq 123
     end
 
     it "gets data with a string key" do
-      subject["parentId"].should == 456
+      expect(subject["parentId"]).to eq 456
     end
 
     it "get nil for unknown data" do
-      subject["whatever"].should be_nil
+      expect(subject["whatever"]).to be_nil
     end
 
     it "gets attributes not revealed by ecwid_reader or ecwid_accessor" do
-      subject["hidden"].should == "tee hee"
+      expect(subject["hidden"]).to eq "tee hee"
+    end
+  end
+
+  describe "#==" do
+    context "with and without a client" do
+      let(:other) { EntitySubject.new(data, client: client) }
+
+      it "returns true" do
+        expect(subject).to eq(other)
+      end
     end
   end
 
   describe "overrides" do
-    its(:override) { should == "UPCASE ME" }
+    it { is_expected.to have_attributes(override: "UPCASE ME") }
   end
 
   describe "accessors" do
-
     describe "::ecwid_reader" do
       it "makes data accessible with a snake cased method" do
-        subject.parent_id.should == 456
+        expect(subject.parent_id).to eq 456
       end
 
       it "doesn't have a writer" do
@@ -80,7 +88,7 @@ describe EcwidApi::Entity do
     describe "::ecwid_writer" do
       it "creates a writer method" do
         subject.write_only = "yee haw!"
-        subject["writeOnly"].should == "yee haw!"
+        expect(subject["writeOnly"]).to eq "yee haw!"
       end
 
       it "doesn't have a reader" do
@@ -91,13 +99,13 @@ describe EcwidApi::Entity do
     describe "::ecwid_accessor" do
       it "creates a reader and a writer" do
         subject.the_status = "MATURE"
-        subject.the_status.should == "MATURE"
+        expect(subject.the_status).to eq "MATURE"
       end
     end
 
     describe "without an accessor" do
       it "is accessible with []" do
-        subject[:hidden].should == "tee hee"
+        expect(subject[:hidden]).to eq "tee hee"
       end
 
       it "doesn't have an access method" do
@@ -105,4 +113,23 @@ describe EcwidApi::Entity do
       end
     end
   end
-end
+
+  describe "marshaling" do
+    context "with a client" do
+      subject { EntitySubject.new(data, client: client) }
+
+      describe "dump" do
+        it "does not raise" do
+          expect { Marshal.dump(subject) }.not_to raise_error
+        end
+      end
+
+      describe "load" do
+        it "converts a dumped object" do
+          source = Marshal.dump(subject)
+          expect(Marshal.load(source)).to eq(subject)
+        end
+      end
+    end
+  end
+end