ecwid_api 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 46dcd4e6a2d43c7fad4d64e00476a240b0d18c02
-  data.tar.gz: ea1cccacb59b117efa147353ad038605a867a957
+SHA256:
+  metadata.gz: b3586666f15cbba13b4138fd19fba02ac3e1dffccc70803d975215e447b8471b
+  data.tar.gz: 9aadcd7b9217e1e92cebdaba858da43cf359873b7d2be100a63f514313da63fd
 SHA512:
-  metadata.gz: c8c88afb4c895ef03be8d767e2d8a347ca4109852813df33fc77126ada5109bc67c5809faaf48f77e2a8152eaea4be1e09e1a2478cf33204c3ac80ab73da6e13
-  data.tar.gz: e7a441c8d51c30971954ad531930c7777a5af0abde8d77cfd850ab41c4e382397cdbc3f2d932f9ba7d11aeadf4b1cbefccc123ca6ed3fb60fd8e79d3d0e7b648
+  metadata.gz: 0d83a8bf4a7460bdbbf86b878b3383bd29fbb40659a7b3f3e796b058d20e36d6ec4ff8a0af33f50e34d888157eb3d75d28aec4d8a2c9b92870e19928fd0e504c
+  data.tar.gz: ce28316fc8cee04433d47b04ea9c58d79c6b2519aab5cd27735338268601c763c9d4cde6cef4afe463169078d94611febb637f93d0dd77f0861420df34a05159

data/README.md

@@ -2,14 +2,14 @@
 
 A gem to interface with the Ecwid REST APIs.
 
-[![Code Climate](https://codeclimate.com/github/davidbiehl/ecwid_api.png)](https://codeclimate.com/github/davidbiehl/ecwid_api)
-[![Build Status](https://travis-ci.org/davidbiehl/ecwid_api.svg?branch=master)](https://travis-ci.org/davidbiehl/ecwid_api)
+[![Code Climate](https://codeclimate.com/github/vishalzambre/ecwid_api.png)](https://codeclimate.com/github/vishalzambre/ecwid_api)
+[![Build Status](https://travis-ci.org/vishalzambre/ecwid_api.svg?branch=master)](https://travis-ci.org/vishalzambre/ecwid_api)
 
 ## API v3 Warning!
 
 This is for the latest version of the API, also known as v3, which is currently
 in closed beta! The (incomplete) v1 API is still available on the
-[api-v1 branch](https://github.com/davidbiehl/ecwid_api/tree/api-v1).
+[api-v1 branch](https://github.com/vishalzambre/ecwid_api/tree/api-v1).
 
 To participate in the beta, please contact Ecwid and they will give you the
 information necessary to configure and authorize your application with OAuth2.
@@ -196,12 +196,20 @@ that feature.
 
 ## Contributing
 
-1. Fork it ( http://github.com/davidbiehl/ecwid_api/fork )
+1. Fork it ( http://github.com/vishalzambre/ecwid_api/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Authors
+
+* **Vishal Zambre** - *Current work* - [vishalzambre](https://github.com/vishalzambre)
+* **David Biehl** - *Initial work* - [davidbiehl](https://github.com/davidbiehl)
+
+See also the list of [contributors](https://github.com/vishalzambre/ecwid_api/contributors) who participated in this project.
+
+
 ## License
 
 The MIT License (MIT)

data/ecwid_api.gemspec

@@ -6,22 +6,23 @@ require 'ecwid_api/version'
 Gem::Specification.new do |spec|
   spec.name          = "ecwid_api"
   spec.version       = EcwidApi::VERSION
-  spec.authors       = ["David Biehl"]
-  spec.email         = ["me@davidbiehl.com"]
+  spec.authors       = ["David Biehl", "Vishal Zambre"]
+  spec.email         = ["v.zambre@gmail.com"]
   spec.summary       = %q{A client for the Ecwid REST API}
   spec.description   = %q{A client for the Ecwid REST API in Ruby}
-  spec.homepage      = "https://github.com/davidbiehl/ecwid_api"
+  spec.homepage      = "https://github.com/vishalzambre/ecwid_api"
   spec.license       = "MIT"
+  spec.post_install_message = "Thanks for installing!"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 1.5", ">= 1.5"
   spec.add_development_dependency "rake", "~> 0"
-  spec.add_development_dependency "rspec", "~> 2.14", ">= 2.14.1"
+  spec.add_development_dependency "rspec", "~> 3.5", ">= 3.5"
 
-  spec.add_dependency "faraday", "~> 0.9.0"
-  spec.add_dependency "faraday_middleware", "~> 0.9.1"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
 end

data/lib/ecwid_api.rb

@@ -16,10 +16,13 @@ module EcwidApi
   require_relative "ecwid_api/entity"
 
   require_relative "ecwid_api/category"
+  require_relative "ecwid_api/customer"
   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"
+  require_relative "ecwid_api/product_type"
+  require_relative "ecwid_api/product_type_attribute"
 end

data/lib/ecwid_api/api.rb

@@ -1,9 +1,12 @@
 module EcwidApi
   module Api
     require_relative "api/base"
-    require_relative "api/orders"
-    require_relative "api/products"
+
     require_relative "api/categories"
+    require_relative "api/customers"
+    require_relative "api/orders"
     require_relative "api/product_combinations"
+    require_relative "api/product_types"
+    require_relative "api/products"
   end
-end
+end

data/lib/ecwid_api/api/customers.rb

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

data/lib/ecwid_api/api/orders.rb

@@ -20,13 +20,13 @@ module EcwidApi
         end
       end
 
-      # Public: Finds a an Order given an Ecwid order_number
+      # Public: Finds a an Order given an Ecwid id
       #
-      # order_number - an Integer that is the Ecwid Order number
+      # id - 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}")
+      def find(id)
+        response = client.get("orders/#{id}")
         if response.success?
           Order.new(response.body, client: client)
         end

data/lib/ecwid_api/api/product_types.rb

@@ -0,0 +1,56 @@
+require_relative "../unpaged_ecwid_response"
+
+ module EcwidApi
+  module Api
+    class ProductTypes < Base
+      # Public: Get all of the ProductType objects for the Ecwid store
+      #
+      # Returns an Array of ProductType objects
+      # NOTE: This endpoint does not behave like other Ecwid endpoints in that
+      #       it does not return paged results.  It simply returns every
+      #       result in an array, without a wrapper with an "items" property.
+      def all(params = {})
+        UnpagedEcwidResponse.new(client, "classes") do |product_type_hash|
+          ProductType.new(product_type_hash, client: client)
+        end
+      end
+
+       # Public: Finds a single product_type by product_type ID
+      #
+      # id - an Ecwid product_type ID
+      #
+      # Returns a ProductType object, or nil if one can't be found
+      def find(id)
+        response = client.get("classes/#{id}")
+        if response.success?
+          ProductType.new(response.body, client: client)
+        end
+      end
+
+       # Public: Creates a new ProductType
+      #
+      # params - a Hash
+      #
+      # Raises an Error if there is a problem
+      #
+      # Returns a ProductType object
+      def create(params)
+        response = client.post("classes", params)
+        find(response.body["id"])
+      end
+
+       # Public: Updates an existing ProductType
+      #
+      # id - the Ecwid product_type ID
+      # params - a Hash
+      #
+      # Raises an Error if there is a problem
+      #
+      # Returns a ProductType object
+      def update(id, params)
+        client.put("classes/#{id}", params)
+        find(id)
+      end
+    end
+  end
+end

data/lib/ecwid_api/api/products.rb

@@ -4,7 +4,77 @@ module EcwidApi
   module Api
     class Products < Base
       # Public: Get all of the Product objects for the Ecwid store
-      #
+      # params - a hash of request parameters. Parameters can be
+      #   keyword                     string            Search term. Use quotes to search for exact match. 
+      #                                                 Ecwid searches products over multiple fields:
+      #                                                   * title
+      #                                                   * description
+      #                                                   * SKU
+      #                                                   * product options
+      #                                                   * category name
+      #                                                   * gallery image descriptions
+      #                                                   * attribute values (except for hidden attributes). 
+      #                                                     If your keywords contain special characters, 
+      #                                                     it may make sense to URL encode them before making a request
+      #   priceFrom                   number            Minimum product price
+      #   priceTo                     number            Maximum product price
+      #   category                    number            Category ID. To get Store Front Page products, specify `&category=0` in the request
+      #   withSubcategories           boolean           `true/false`: defines whether Ecwid should search in subcategories of the 
+      #                                                 category you set in `category` field. Ignored if `category` field is not set.
+      #                                                 `false` is the default value
+      #   sortBy                      string            Sort order. Supported values:
+      #                                                   * `RELEVANCE` default
+      #                                                   * `DEFINED_BY_STORE_OWNER`
+      #                                                   * `ADDED_TIME_DESC`
+      #                                                   * `ADDED_TIME_ASC`
+      #                                                   * `NAME_ASC`
+      #                                                   * `NAME_DESC`
+      #                                                   * `PRICE_ASC`
+      #                                                   * `PRICE_DESC`
+      #                                                   * `UPDATED_TIME_ASC`
+      #                                                   * `UPDATED_TIME_DESC`
+      #                                                 . If request is applicable to a specific category (i.e. `category` is set), 
+      #                                                 then `DEFINED_BY_STORE_OWNER` sort method is used
+      #   offset                      number            Offset from the beginning of the returned items list (for paging)
+      #   limit                       number            Maximum number of returned items. Maximum allowed value: `100`. Default value: `100`
+      #   createdFrom                 string            Product creation date/time (lower bound). Supported formats:
+      #                                                   * UNIX timestamp
+      #                                                 Examples:
+      #                                                   * `1447804800`
+      #   createdTo                   string            Product creation date/time (upper bound). Supported formats:
+      #                                                   * UNIX timestamp
+      #   updatedFrom                 string            Product last update date/time (lower bound). Supported formats:
+      #                                                   * UNIX timestamp
+      #   updatedTo                   string            Product last update date/time (upper bound). Supported formats:
+      #                                                   * UNIX timestamp
+      #   enabled                     boolean           `true` to get only enabled products, `false` to get only disabled products
+      #   inStock                     boolean           `true` to get only products in stock, `false` to get out of stock products
+      #   sku                         string            Product or variation SKU. Ecwid will return details of a product containing that SKU, 
+      #                                                 if SKU value is an exact match. If SKU is specified, other search parameters are ignored, 
+      #                                                 except for product ID.
+      #   productId                   number            Internal Ecwid product ID or multiple productIds separated by a comma. If this field is 
+      #                                                 specified, other search parameters are ignored.
+      #   baseUrl                     string            Storefront URL for Ecwid to use when returning product URLs in the url field. 
+      #                                                 If not specified, Ecwid will use the storefront URL specified in the store settings
+      #   cleanUrls                   boolean           If `true`, Ecwid will return the SEO-friendly clean URL (without hash `'#'`) in the `url` field. 
+      #                                                 If `false`, Ecwid will return URL in the old format (with hash `'#'`). We recommend using 
+      #                                                 `true` value if merchant’s website supports clean SEO-friendly URL feature
+      #   onsale                      string            Use `"onsale"` to get on sale items only or `"notonsale"` for items not currently on sale.
+      #   option_{optionName}         string            Filter by product option values. Format: `option_{optionName}=param[,param]`, 
+      #                                                 where optionName is the attribute name and param is the attribute value. 
+      #                                                 You can place several values separated by comma. In that case, values will be connected 
+      #                                                 through logical “OR”, and if the product has at least one of them it will get to the 
+      #                                                 search results. Example:
+      #                                                   `option_Size=S,M,L&option_Color=Red,Black`
+      #   attribute_{attributeName}   string            Filter by product attribute values. Format: `attribute_{attributeName}=param[,param]`, 
+      #                                                 where attributeName is the attribute name and param is the attribute value. 
+      #                                                 You can place several values separated by comma. In that case, values will be connected 
+      #                                                 through logical “OR”, and if the product has at least one of them it will get to the 
+      #                                                 search results. Example:
+      #                                                   `attribute_Brand=Apple&attribute_Capacity=32GB,64GB`
+      #   lang                        string            Preferred language for the product fields in search results. 
+      #                                                 If a certain field does not have the translation available for the set language, 
+      #                                                 the default language text will be used for that field.
       # Returns an Array of Product objects
       def all(params = {})
         PagedEcwidResponse.new(client, "products", params) do |product_hash|
@@ -15,10 +85,18 @@ module EcwidApi
       # Public: Finds a single product by product ID
       #
       # id - an Ecwid product ID
-      #
+      # params - a hash of request parameters. Parameters can be
+      #   baseUrl                     string            Storefront URL for Ecwid to use when returning product URLs in the url field. 
+      #                                                 If not specified, Ecwid will use the storefront URL specified in the 
+      #   cleanUrls                   boolean           If `true`, Ecwid will return the SEO-friendly clean URL (without hash '#') 
+      #                                                 in the url field. If `false`, Ecwid will return URL in the old format (with hash '#'). 
+      #                                                 We recommend using `true` value if merchant’s website supports clean
+      #   lang                        string            Preferred language for the product fields in search results. If a certain field does 
+      #                                                 not have the translation available for the set language, the default language text 
+      #                                                 will be used for that field.
       # Returns a Product object, or nil if one can't be found
-      def find(id)
-        response = client.get("products/#{id}")
+      def find(id, params = {})
+        response = client.get("products/#{id}", params)
         if response.success?
           Product.new(response.body, client: client)
         end
@@ -27,10 +105,18 @@ module EcwidApi
       # Public: Finds a single Product by SKU
       #
       # sku - a SKU of a product
-      #
+      # params - a hash of request parameters. Parameters can be
+      #   baseUrl                     string            Storefront URL for Ecwid to use when returning product URLs in the url field. 
+      #                                                 If not specified, Ecwid will use the storefront URL specified in the 
+      #   cleanUrls                   boolean           If `true`, Ecwid will return the SEO-friendly clean URL (without hash '#') 
+      #                                                 in the url field. If `false`, Ecwid will return URL in the old format (with hash '#'). 
+      #                                                 We recommend using `true` value if merchant’s website supports clean
+      #   lang                        string            Preferred language for the product fields in search results. If a certain field does 
+      #                                                 not have the translation available for the set language, the default language text 
+      #                                                 will be used for that field.      
       # 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 }
+      def find_by_sku(sku, params = {})
+        all(params.merge(keyword: sku)).find { |product| product[:sku] == sku }
       end
 
       # Public: Creates a new Product

data/lib/ecwid_api/client.rb

@@ -20,7 +20,7 @@ module EcwidApi
     attr_reader :token
     attr_reader :adapter
 
-    attr_reader :connection, :categories, :orders, :products
+    attr_reader :connection, :categories, :customers, :orders, :products, :product_types
 
     # Public: Initializes a new Client to interact with the API
     #
@@ -41,9 +41,11 @@ module EcwidApi
         conn.adapter  adapter
       end
 
-      @categories = Api::Categories.new(self)
-      @orders     = Api::Orders.new(self)
-      @products   = Api::Products.new(self)
+      @categories     = Api::Categories.new(self)
+      @customers      = Api::Customers.new(self)
+      @orders         = Api::Orders.new(self)
+      @products       = Api::Products.new(self)
+      @product_types  = Api::ProductTypes.new(self)
     end
 
     # Public: The URL of the API for the Ecwid Store
@@ -97,4 +99,4 @@ module EcwidApi
       end
     end
   end
-end
+end

data/lib/ecwid_api/customer.rb

@@ -0,0 +1,10 @@
+module EcwidApi
+  class Customer < Entity
+    self.url_root = "customers"
+
+     ecwid_reader :name, :email, :totalOrderCount, :customerGroupId, :customerGroupName
+
+     ecwid_writer :name, :email
+
+   end
+end

data/lib/ecwid_api/entity.rb

@@ -1,8 +1,8 @@
 module EcwidApi
   class Entity
     # Private: Gets the Hash of data
-    attr_reader :data
-    protected   :data
+    attr_reader :data, :new_data
+    protected   :data, :new_data
 
     attr_reader :client
     private     :client
@@ -173,5 +173,17 @@ module EcwidApi
     def to_json(*args)
       data.to_json(*args)
     end
+
+    def marshal_dump
+      [@data, @new_data]
+    end
+
+    def marshal_load(array)
+      @data, @new_data = *array
+    end
+
+    def ==(other)
+      data == other.data && new_data == other.new_data
+    end
   end
-end
+end