ecwid_api 0.1.0 → 0.2.0

data/lib/ecwid_api/category.rb

@@ -1,5 +1,3 @@
-require "open-uri"
-
 module EcwidApi
   class Category < Entity
     self.url_root = "categories"
@@ -59,11 +57,7 @@ module EcwidApi
     #
     # Returns a Faraday::Response object
     def upload_image!(filename)
-      client.post("categories/#{id}/image") do |req|
-        req.body = open(filename).read
-      end.tap do |response|
-        raise_on_failure(response)
-      end
+      client.post_image("categories/#{id}/image", filename)
     end
   end
 end

data/lib/ecwid_api/client.rb

@@ -1,66 +1,100 @@
-module EcwidApi
-  # Public: Client objects manage the connection and interface to a single Ecwid
-  # store.
-  #
-  # Examples
-  #
-  #   client = EcwidApi::Client.new(store_id: '12345', token: 'the access_token')
-  #   client.get "/products"
-  #
-  class Client
-    extend Forwardable
-
-    # The default base URL for the Ecwid API
-    DEFAULT_URL = "https://app.ecwid.com/api/v3"
-
-    # Public: Returns the Ecwid Store ID
-    attr_reader :store_id
-    attr_reader :token
-    attr_reader :adapter
-
-    # Public: Initializes a new Client to interact with the API
-    #
-    # store_id - the Ecwid store_id to interact with
-    # token    - the authorization token provided by oAuth. See the
-    #            Authentication class
-    #
-    def initialize(store_id, token, adapter = Faraday.default_adapter)
-      @store_id, @token, @adapter = store_id, token, adapter
-    end
-
-    # Public: The URL of the API for the Ecwid Store
-    def store_url
-      "#{DEFAULT_URL}/#{store_id}"
-    end
-
-    def_delegators :connection, :get, :post, :put, :delete
-
-    # Public: Returns the Category API
-    def categories
-      @categories ||= Api::Categories.new(self)
-    end
-
-    # Public: Returns the Order API
-    def orders
-      @orders ||= Api::Orders.new(self)
-    end
-
-    # Public: Returns the Products API
-    def products
-      @products ||= Api::Products.new(self)
-    end
-
-    # Private: Returns a Faraday connection to interface with the Ecwid API
-    def connection
-      @connection ||= Faraday.new store_url do |conn|
-        conn.request  :oauth2, token, param_name: :token
-        conn.request  :json
-
-        conn.response :json, content_type: /\bjson$/
-        conn.response :logger
-
-        conn.adapter  adapter
-      end
-    end
-  end
+require "open-uri"
+
+module EcwidApi
+  # Public: Client objects manage the connection and interface to a single Ecwid
+  # store.
+  #
+  # Examples
+  #
+  #   client = EcwidApi::Client.new(store_id: '12345', token: 'the access_token')
+  #   client.get "/products"
+  #
+  class Client
+    extend Forwardable
+
+    # The default base URL for the Ecwid API
+    DEFAULT_URL = "https://app.ecwid.com/api/v3"
+
+    # Public: Returns the Ecwid Store ID
+    attr_reader :store_id
+    attr_reader :token
+    attr_reader :adapter
+
+    attr_reader :connection, :categories, :orders, :products
+
+    # Public: Initializes a new Client to interact with the API
+    #
+    # store_id - the Ecwid store_id to interact with
+    # token    - the authorization token provided by oAuth. See the
+    #            Authentication class
+    #
+    def initialize(store_id, token, adapter = Faraday.default_adapter)
+      @store_id, @token, @adapter = store_id, token, adapter
+
+      @connection = Faraday.new store_url do |conn|
+        conn.request  :oauth2, token, param_name: :token
+        conn.request  :json
+
+        conn.response :json, content_type: /\bjson$/
+        conn.response :logger
+
+        conn.adapter  adapter
+      end
+
+      @categories = Api::Categories.new(self)
+      @orders     = Api::Orders.new(self)
+      @products   = Api::Products.new(self)
+    end
+
+    # Public: The URL of the API for the Ecwid Store
+    def store_url
+      "#{DEFAULT_URL}/#{store_id}"
+    end
+
+    def_delegators :connection, :get
+
+    def post(*args, &block)
+      raise_on_failure connection.post(*args, &block)
+    end
+
+    def put(*args, &block)
+      raise_on_failure connection.put(*args, &block)
+    end
+
+    def delete(*args, &block)
+      raise_on_failure connection.delete(*args, &block)
+    end
+
+    # Public: A helper method for POSTing an image
+    #
+    # url - the URL to POST the image to
+    # filename - the path or URL to the image to upload
+    #
+    # Returns a Faraday::Response
+    #
+    def post_image(url, filename)
+      post(url) do |req|
+        req.body = open(filename).read
+      end
+    end
+
+    private
+
+    # Private: Raises a ResponseError if the request failed
+    #
+    # response - a Faraday::Response object that is the result of a request
+    #
+    # Raises ResponseError if the request wasn't successful
+    #
+    # Returns the original response if the request was successful
+    #
+    #
+    def raise_on_failure(response)
+      if response.success?
+        response
+      else
+        raise ResponseError.new(response)
+      end
+    end
+  end
 end

data/lib/ecwid_api/entity.rb

@@ -1,11 +1,12 @@
 module EcwidApi
   class Entity
-    include Api
-
     # Private: Gets the Hash of data
     attr_reader :data
     protected   :data
 
+    attr_reader :client
+    private     :client
+
     class << self
       attr_accessor :url_root
 
@@ -154,7 +155,6 @@ module EcwidApi
     def save
       unless @new_data.empty?
         client.put(url, @new_data).tap do |response|
-          raise_on_failure(response)
           @data.merge!(@new_data)
           @new_data.clear
         end
@@ -163,9 +163,7 @@ module EcwidApi
 
     # Public: Destroys the Entity
     def destroy!
-      client.delete(url).tap do |response|
-        raise_on_failure(response)
-      end
+      client.delete(url)
     end
 
     def to_hash

data/lib/ecwid_api/error.rb

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

data/lib/ecwid_api/o_auth.rb

@@ -1,106 +1,106 @@
-require "cgi"
-require "ostruct"
-
-module EcwidApi
-  # Public: Authentication objects manage OAuth authentication with an Ecwid
-  #         store.
-  #
-  # Examples
-  #
-  #   app = EcwidApi::Authentication.new do |config|
-  #     # see initialize for configuration
-  #   end
-  #
-  #   app.oauth_url  # send the user here to authorize the app
-  #
-  #   token = app.access_token(params[:code]) # this is the code they provide
-  #                                           # to the redirect_uri
-  #   token.access_token
-  #   token.store_id      # these are what you need to access the API
-  #
-  class OAuth
-    CONFIG = %w(client_id client_secret scope redirect_uri)
-    attr_accessor *CONFIG
-
-    # Public: Initializes a new Ecwid Authentication for OAuth
-    #
-    # Examples
-    #
-    #   app = EcwidApi::Authentication.new do |config|
-    #     config.client_id     = "some client id"
-    #     config.client_secret = "some client secret"
-    #     config.scope         "this_is_what_i_want_to_do oh_and_that_too"
-    #     config.redirect_uri  = "https://example.com/oauth"
-    #   end
-    #
-    def initialize
-      yield(self) if block_given?
-      CONFIG.each do |method|
-        raise Error.new("#{method} is required to initialize a new EcwidApi::Authentication") unless send(method)
-      end
-    end
-
-    # Public: The URL for OAuth authorization.
-    #
-    # This is the URL that the user will need to go to to authorize the app
-    # with the Ecwid store.
-    #
-    def oauth_url
-      "https://my.ecwid.com/api/oauth/authorize?" + oauth_query
-    end
-
-    # Public: Obtain the access token in order to use the API
-    #
-    # code - the temporary code obtained from the authorization callback
-    #
-    # Examples
-    #
-    #   token = app.access_token(params[:code])
-    #   token.access_token  # the access token that authenticates each API request
-    #   token.store_id      # the authenticated Ecwid store_id
-    #
-    # Returns an OpenStruct which responds with the information needed to
-    # access the API for a store.
-    def access_token(code)
-      response = connection.post("/api/oauth/token",
-        client_id:     client_id,
-        client_secret: client_secret,
-        code:          code,
-        redirect_uri:  redirect_uri,
-        grant_type:    "authorization_code"
-      )
-
-      if response.success?
-        OpenStruct.new(response.body)
-      else
-        raise Error.new(response.body["error_description"])
-      end
-    end
-
-    private
-
-    # Private: The query parameters for the OAuth authorization request
-    #
-    # Returns a String of query parameters
-    def oauth_query
-      {
-        client_id:     client_id,
-        scope:         scope,
-        response_type: "code",
-        redirect_uri:  redirect_uri
-      }.map do |key, val|
-        "#{CGI.escape(key.to_s)}=#{CGI.escape(val.to_s)}"
-      end.join(?&)
-    end
-
-    # Private: Returns a connection for obtaining an access token from Ecwid
-    #
-    def connection
-      @connection ||= Faraday.new "https://my.ecwid.com" do |conn|
-        conn.request  :url_encoded
-        conn.response :json, content_type: /\bjson$/
-        conn.adapter  Faraday.default_adapter
-      end
-    end
-  end
+require "cgi"
+require "ostruct"
+
+module EcwidApi
+  # Public: Authentication objects manage OAuth authentication with an Ecwid
+  #         store.
+  #
+  # Examples
+  #
+  #   app = EcwidApi::Authentication.new do |config|
+  #     # see initialize for configuration
+  #   end
+  #
+  #   app.oauth_url  # send the user here to authorize the app
+  #
+  #   token = app.access_token(params[:code]) # this is the code they provide
+  #                                           # to the redirect_uri
+  #   token.access_token
+  #   token.store_id      # these are what you need to access the API
+  #
+  class OAuth
+    CONFIG = %w(client_id client_secret scope redirect_uri)
+    attr_accessor *CONFIG
+
+    # Public: Initializes a new Ecwid Authentication for OAuth
+    #
+    # Examples
+    #
+    #   app = EcwidApi::Authentication.new do |config|
+    #     config.client_id     = "some client id"
+    #     config.client_secret = "some client secret"
+    #     config.scope         "this_is_what_i_want_to_do oh_and_that_too"
+    #     config.redirect_uri  = "https://example.com/oauth"
+    #   end
+    #
+    def initialize
+      yield(self) if block_given?
+      CONFIG.each do |method|
+        raise Error.new("#{method} is required to initialize a new EcwidApi::Authentication") unless send(method)
+      end
+    end
+
+    # Public: The URL for OAuth authorization.
+    #
+    # This is the URL that the user will need to go to to authorize the app
+    # with the Ecwid store.
+    #
+    def oauth_url
+      "https://my.ecwid.com/api/oauth/authorize?" + oauth_query
+    end
+
+    # Public: Obtain the access token in order to use the API
+    #
+    # code - the temporary code obtained from the authorization callback
+    #
+    # Examples
+    #
+    #   token = app.access_token(params[:code])
+    #   token.access_token  # the access token that authenticates each API request
+    #   token.store_id      # the authenticated Ecwid store_id
+    #
+    # Returns an OpenStruct which responds with the information needed to
+    # access the API for a store.
+    def access_token(code)
+      response = connection.post("/api/oauth/token",
+        client_id:     client_id,
+        client_secret: client_secret,
+        code:          code,
+        redirect_uri:  redirect_uri,
+        grant_type:    "authorization_code"
+      )
+
+      if response.success?
+        OpenStruct.new(response.body)
+      else
+        raise Error.new(response.body["error_description"])
+      end
+    end
+
+    private
+
+    # Private: The query parameters for the OAuth authorization request
+    #
+    # Returns a String of query parameters
+    def oauth_query
+      {
+        client_id:     client_id,
+        scope:         scope,
+        response_type: "code",
+        redirect_uri:  redirect_uri
+      }.map do |key, val|
+        "#{CGI.escape(key.to_s)}=#{CGI.escape(val.to_s)}"
+      end.join(?&)
+    end
+
+    # Private: Returns a connection for obtaining an access token from Ecwid
+    #
+    def connection
+      @connection ||= Faraday.new "https://my.ecwid.com" do |conn|
+        conn.request  :url_encoded
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+  end
 end