ecwid_api 0.1.0 → 0.2.0

data/ecwid_api.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["David Biehl"]
   spec.email         = ["me@davidbiehl.com"]
   spec.summary       = %q{A client for the Ecwid REST API}
-  spec.homepage      = ""
+  spec.description   = %q{A client for the Ecwid REST API in Ruby}
+  spec.homepage      = "https://github.com/davidbiehl/ecwid_api"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,9 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.14.1"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rspec", "~> 2.14", ">= 2.14.1"
 
   spec.add_dependency "faraday", "~> 0.9.0"
   spec.add_dependency "faraday_middleware", "~> 0.9.1"

data/lib/ecwid_api.rb

@@ -1,25 +1,25 @@
-require "ecwid_api/version"
-require "ext/string"
-require 'faraday'
-require 'faraday_middleware'
-
-require_relative "ecwid_api/error"
-
-# Public: This is the main namespace for the EcwidApi. It can be used to store
-# the default client.
-#
-module EcwidApi
-  autoload :OAuth, "ecwid_api/o_auth"
-  autoload :Client, "ecwid_api/client"
-  autoload :ResponseError, "ecwid_api/error"
-  autoload :Entity, "ecwid_api/entity"
-  autoload :Api, "ecwid_api/api"
-
-  autoload :Category, "ecwid_api/category"
-  autoload :Order, "ecwid_api/order"
-  autoload :OrderItem, "ecwid_api/order_item"
-  autoload :Person, "ecwid_api/person"
-  autoload :ProductCombination, "ecwid_api/product_combination"
-
-  autoload :Product,    "ecwid_api/product"
-end
+require "ecwid_api/version"
+require "ext/string"
+require 'faraday'
+require 'faraday_middleware'
+
+require_relative "ecwid_api/error"
+
+# Public: This is the main namespace for the EcwidApi. It can be used to store
+# the default client.
+#
+module EcwidApi
+  require_relative "ecwid_api/o_auth"
+  require_relative "ecwid_api/client"
+  require_relative "ecwid_api/error"
+  require_relative "ecwid_api/api"
+  require_relative "ecwid_api/entity"
+
+  require_relative "ecwid_api/category"
+  require_relative "ecwid_api/order"
+  require_relative "ecwid_api/order_item"
+  require_relative "ecwid_api/person"
+  require_relative "ecwid_api/product_combination"
+
+  require_relative "ecwid_api/product"
+end

data/lib/ecwid_api/api.rb

@@ -1,31 +1,9 @@
-module EcwidApi
-  # Internal: A base class for common API functionality
-  module Api
-    autoload :Base,                "ecwid_api/api/base"
-    autoload :Orders,              "ecwid_api/api/orders"
-    autoload :Products,            "ecwid_api/api/products"
-    autoload :Categories,          "ecwid_api/api/categories"
-    autoload :ProductCombinations, "ecwid_api/api/product_combinations"
-
-    # Private: Gets the Client
-    attr_reader :client
-    private     :client
-
-    # Private: Raises an Error if a request failed, otherwise it will
-    # yield the block
-    #
-    # response - a Faraday::Response object
-    #
-    # Yield if the response was successful
-    #
-    # Raises an error with the status code and reason if the response failed
-    #
-    def raise_on_failure(response)
-      if response.success?
-        yield(response) if block_given?
-      else
-        raise ResponseError.new(response)
-      end
-    end
-  end
+module EcwidApi
+  module Api
+    require_relative "api/base"
+    require_relative "api/orders"
+    require_relative "api/products"
+    require_relative "api/categories"
+    require_relative "api/product_combinations"
+  end
 end

data/lib/ecwid_api/api/base.rb

@@ -1,17 +1,18 @@
-module EcwidApi
-  module Api
-    # Internal: A base class for common API functionality
-    class Base
-      include Api
-
-      # Public: Initializes a new EcwidApi::CategoryApi
-      #
-      # client - The EcwidApi::Client to use with the API
-      #
-      def initialize(client)
-        @client = client
-        raise Error.new("The client cannot be nil") unless client
-      end
-    end
-  end
+module EcwidApi
+  module Api
+    # Internal: A base class for common API functionality
+    class Base
+      attr_reader :client
+      private     :client
+
+      # Public: Initializes a new EcwidApi::CategoryApi
+      #
+      # client - The EcwidApi::Client to use with the API
+      #
+      def initialize(client)
+        @client = client
+        raise Error.new("The client cannot be nil") unless client
+      end
+    end
+  end
 end

data/lib/ecwid_api/api/categories.rb

@@ -1,57 +1,56 @@
-require_relative "../paged_ecwid_response"
-
-module EcwidApi
-  module Api
-    class Categories < Base
-      # 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(params = {})
-        PagedEcwidResponse.new(client, "categories", params) do |category_hash|
-          Category.new(category_hash, client: client)
-        end.sort_by(&:order_by)
-      end
-
-      # Public: Returns an Array of the root level EcwidApi::Category objects
-      def root(params = {})
-        all(params.merge(parent: 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(id)
-        response = client.get("categories/#{id}")
-
-        if response.success?
-          Category.new(response.body, client: client)
-        else
-          nil
-        end
-      rescue Zlib::BufError
-        nil
-      end
-
-      # Public: Creates a new Category
-      #
-      # params - a Hash of API keys and their corresponding values
-      #
-      # Returns a new Category entity
-      def create(params)
-        response = client.post("categories", params)
-
-        raise_on_failure(response) { |response| find(response.body["id"]) }
-      end
-    end
-  end
+require_relative "../paged_ecwid_response"
+
+module EcwidApi
+  module Api
+    class Categories < Base
+      # 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(params = {})
+        PagedEcwidResponse.new(client, "categories", params) do |category_hash|
+          Category.new(category_hash, client: client)
+        end.sort_by(&:order_by)
+      end
+
+      # Public: Returns an Array of the root level EcwidApi::Category objects
+      def root(params = {})
+        all(params.merge(parent: 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(id)
+        response = client.get("categories/#{id}")
+
+        if response.success?
+          Category.new(response.body, client: client)
+        else
+          nil
+        end
+      rescue Zlib::BufError
+        nil
+      end
+
+      # Public: Creates a new Category
+      #
+      # params - a Hash of API keys and their corresponding values
+      #
+      # Returns a new Category entity
+      def create(params)
+        response = client.post("categories", params)
+        find(response.body["id"])
+      end
+    end
+  end
 end

data/lib/ecwid_api/api/orders.rb

@@ -1,36 +1,36 @@
-require_relative "../paged_ecwid_response"
-
-module EcwidApi
-  module Api
-    # Public: This is the Ecwid API for Orders. It abstracts the end-points
-    # of the Ecwid API that deal with orders.
-    class Orders < Base
-      # Public: Gets Orders from the Ecwid API
-      #
-      # params - optional parameters that can be used to filter the request.
-      #          For a list of params, please refer to the API documentation:
-      #          http://kb.ecwid.com/w/page/43697230/Order%20API
-      #          Note that the limit and offset parameters will be overridden
-      #          since all orders will be returned and enumerated
-      #
-      # Returns a PagedEnumerator of `EcwidApi::Order` objects
-      def all(params = {})
-        PagedEcwidResponse.new(client, "orders", params) do |order_hash|
-          Order.new(order_hash, client: client)
-        end
-      end
-
-      # Public: Finds a an Order given an Ecwid order_number
-      #
-      # order_number - an Integer that is the Ecwid Order number
-      #
-      # Returns an EcwidApi::Order if found, nil if not
-      def find(order_number)
-        response = client.get("orders/#{order_number}")
-        if response.success?
-          Order.new(response.body, client: client)
-        end
-      end
-    end
-  end
-end
+require_relative "../paged_ecwid_response"
+
+module EcwidApi
+  module Api
+    # Public: This is the Ecwid API for Orders. It abstracts the end-points
+    # of the Ecwid API that deal with orders.
+    class Orders < Base
+      # Public: Gets Orders from the Ecwid API
+      #
+      # params - optional parameters that can be used to filter the request.
+      #          For a list of params, please refer to the API documentation:
+      #          http://kb.ecwid.com/w/page/43697230/Order%20API
+      #          Note that the limit and offset parameters will be overridden
+      #          since all orders will be returned and enumerated
+      #
+      # Returns a PagedEnumerator of `EcwidApi::Order` objects
+      def all(params = {})
+        PagedEcwidResponse.new(client, "orders", params) do |order_hash|
+          Order.new(order_hash, client: client)
+        end
+      end
+
+      # Public: Finds a an Order given an Ecwid order_number
+      #
+      # order_number - an Integer that is the Ecwid Order number
+      #
+      # Returns an EcwidApi::Order if found, nil if not
+      def find(order_number)
+        response = client.get("orders/#{order_number}")
+        if response.success?
+          Order.new(response.body, client: client)
+        end
+      end
+    end
+  end
+end

data/lib/ecwid_api/api/product_combinations.rb

@@ -37,14 +37,11 @@ module EcwidApi
 
       def create(params)
         response = client.post("products/#{product.id}/combinations", params)
-
-        raise_on_failure(response) { find(response.body["id"]) }
+        find(response.body["id"])
       end
 
       def delete_all!
-        client.delete("products/#{product.id}/combinations").tap do |response|
-          raise_on_failure(response)
-        end
+        client.delete("products/#{product.id}/combinations")
       end
     end
   end

data/lib/ecwid_api/api/products.rb

@@ -1,64 +1,62 @@
-require_relative "../paged_ecwid_response"
-
-module EcwidApi
-  module Api
-    class Products < Base
-      # Public: Get all of the Product objects for the Ecwid store
-      #
-      # Returns an Array of Product objects
-      def all(params = {})
-        PagedEcwidResponse.new(client, "products", params) do |product_hash|
-          Product.new(product_hash, client: client)
-        end
-      end
-
-      # Public: Finds a single product by product ID
-      #
-      # id - an Ecwid product ID
-      #
-      # Returns a Product object, or nil if one can't be found
-      def find(id)
-        response = client.get("products/#{id}")
-        if response.success?
-          Product.new(response.body, client: client)
-        end
-      end
-
-      # Public: Finds a single Product by SKU
-      #
-      # sku - a SKU of a product
-      #
-      # Returns a Product object, or nil if one can't be found
-      def find_by_sku(sku)
-        all(keyword: sku).find { |product| product[:sku] == sku }
-      end
-
-      # Public: Creates a new Product
-      #
-      # params - a Hash
-      #
-      # Raises an Error if there is a problem
-      #
-      # Returns a Product object
-      def create(params)
-        response = client.post("products", params)
-
-        raise_on_failure(response) {|response| find(response.body["id"]) }
-      end
-
-      # Public: Updates an existing Product
-      #
-      # id - the Ecwid product ID
-      # params - a Hash
-      #
-      # Raises an Error if there is a problem
-      #
-      # Returns a Product object
-      def update(id, params)
-        response = client.put("products/#{id}", params)
-
-        raise_on_failure(response) { find(id) }
-      end
-    end
-  end
+require_relative "../paged_ecwid_response"
+
+module EcwidApi
+  module Api
+    class Products < Base
+      # Public: Get all of the Product objects for the Ecwid store
+      #
+      # Returns an Array of Product objects
+      def all(params = {})
+        PagedEcwidResponse.new(client, "products", params) do |product_hash|
+          Product.new(product_hash, client: client)
+        end
+      end
+
+      # Public: Finds a single product by product ID
+      #
+      # id - an Ecwid product ID
+      #
+      # Returns a Product object, or nil if one can't be found
+      def find(id)
+        response = client.get("products/#{id}")
+        if response.success?
+          Product.new(response.body, client: client)
+        end
+      end
+
+      # Public: Finds a single Product by SKU
+      #
+      # sku - a SKU of a product
+      #
+      # Returns a Product object, or nil if one can't be found
+      def find_by_sku(sku)
+        all(keyword: sku).find { |product| product[:sku] == sku }
+      end
+
+      # Public: Creates a new Product
+      #
+      # params - a Hash
+      #
+      # Raises an Error if there is a problem
+      #
+      # Returns a Product object
+      def create(params)
+        response = client.post("products", params)
+        find(response.body["id"])
+      end
+
+      # Public: Updates an existing Product
+      #
+      # id - the Ecwid product ID
+      # params - a Hash
+      #
+      # Raises an Error if there is a problem
+      #
+      # Returns a Product object
+      def update(id, params)
+        client.put("products/#{id}", params)
+        find(id)
+      end
+    end
+  end
 end