ecommerce-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24d72bc986b677e164e6714aa8e0b559eecf1b60
+  data.tar.gz: 45fcc9b6a2077c57ae2f59e119741023fc70a8fe
+SHA512:
+  metadata.gz: 570eb44019d806ac722c895353b59387b82c23da6e03102dcd3c41e6c03b567ccb6b337fee43cd0d88bb00d0f29c5553aebd71e0ba73e21fd21e37a84f7696d1
+  data.tar.gz: faccd7f123c023d785013bf794a2c71bd5d32bd1dd476f0f2d5ad93ca20681c1ec0461ae0f018298063dbc42e1b146281f7c46d71f13a75f5cf98474d74564f9

data/.gitignore

@@ -0,0 +1,31 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.env
+.envrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+*.swo
+*~
+.ruby-gemset
+.ruby-version
+doc

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ecommerce-client-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Free Communities Consultoria Em Informática Ltda.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Ecommerce Client
+
+A Ruby client for Myfreecomm's Ecommerce REST API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ecommerce-client-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ecommerce-client-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/ecommerce-client-ruby/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

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+task default: :spec

data/ecommerce-client.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ecommerce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecommerce-client"
+  spec.version       = Ecommerce::VERSION
+  spec.authors       = ["Rafael B. Tauil", "Eduardo Hertz", "Rodrigo Tassinari"]
+  spec.email         = ["rafael@tauil.com.br", "eduardohertz@gmail.com", "rodrigo@pittlandia.net"]
+  spec.summary       = %q{Official Ruby client for Myfreecomm's Ecommerce API.}
+  spec.description   = %q{Official Ruby client for Myfreecomm's Ecommerce API. Ecommerce is a solution to control payments for your products.}
+  spec.homepage      = "https://github.com/myfreecomm/ecommerce-client-ruby"
+  spec.license       = "MIT"
+
+  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_dependency "typhoeus", "~> 0.7.1"
+  spec.add_dependency "multi_json", "~> 1.11"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.2"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "vcr", "~> 2.9"
+end

data/lib/ecommerce.rb

@@ -0,0 +1,25 @@
+require "typhoeus"
+require "multi_json"
+
+require "ecommerce/version"
+require "ecommerce/configuration"
+require "ecommerce/client"
+require "ecommerce/attribute_handler"
+
+require "ecommerce/resources/base"
+require "ecommerce/resources/order"
+require "ecommerce/resources/order_collection"
+
+module Ecommerce
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.client
+    Client.new(Ecommerce.configuration.token, Ecommerce.configuration.secret)
+  end
+end

data/lib/ecommerce/attribute_handler.rb

@@ -0,0 +1,51 @@
+require 'bigdecimal'
+
+module Ecommerce
+  class AttributeHandler
+
+    KINDS = [:decimal, :date, :datetime]
+
+    attr_reader :attribute
+
+    def initialize(attribute)
+      @attribute = attribute
+    end
+
+    def self.handle(attribute)
+      self.new(attribute).handle
+    end
+
+    def handle
+      KINDS.each do |kind|
+        return send("as_#{kind}") if send("is_#{kind}?")
+      end
+      attribute
+    end
+
+    private
+
+    def is_decimal?
+      attribute =~ /\A\d+\.\d+\Z/
+    end
+
+    def is_date?
+      attribute =~ /\A\d+{4}\-\d+{2}\-\d+{2}\Z/
+    end
+
+    def is_datetime?
+      attribute =~ /\A\d+{4}\-\d+{2}\-\d+{2}[T ]?\d+{2}\:\d+{2}\:\d+{2}[Z]?\Z/
+    end
+
+    def as_decimal
+      BigDecimal.new(attribute)
+    end
+
+    def as_date
+      Date.parse(attribute)
+    end
+
+    def as_datetime
+      DateTime.parse(attribute)
+    end
+  end
+end

data/lib/ecommerce/client.rb

@@ -0,0 +1,45 @@
+require "ecommerce/request"
+require "ecommerce/response"
+
+module Ecommerce
+  class Client
+    attr_reader :token, :secret
+
+    def initialize(token, secret)
+      @token = token
+      @secret = secret
+    end
+
+    def authenticated?(plan)
+      get("/api/orders/#{plan}/") { |response| response.code == 200 }
+    rescue RequestError => e
+      raise e unless [401, 403].include?(e.code)
+      false
+    end
+
+    %w[get post delete put patch].each do |m|
+      define_method(m) do |path, options = {}, &block|
+        send_request(m.to_sym, path, options, &block)
+      end
+    end
+
+    private
+
+    def send_request(method, path, options, &block)
+      request  = Request.new(options.merge!({
+        method: method,
+        authorization_hash: authorization_hash,
+        url: "#{Ecommerce.configuration.url}#{path}",
+        user_agent: Ecommerce.configuration.user_agent
+      }))
+
+      response = Response.new(request.run)
+
+      response.resolve!(&block)
+    end
+
+    def authorization_hash
+      ::Base64.strict_encode64("#{token}:#{secret}")
+    end
+  end
+end

data/lib/ecommerce/configuration.rb

@@ -0,0 +1,14 @@
+require "base64"
+
+module Ecommerce
+  class Configuration
+    attr_accessor :url, :user_agent, :token, :secret
+
+    def initialize
+      @url = "https://ecommerce.myfreecomm.com.br"
+      @user_agent = "Ecommerce Ruby Client v#{Ecommerce::VERSION}"
+      @token = nil
+      @secret = nil
+    end
+  end
+end

data/lib/ecommerce/exception.rb

@@ -0,0 +1,11 @@
+module Ecommerce
+  class Exception < StandardError
+    attr_accessor :code, :body
+
+    def initialize(args = {})
+      super(args[:message])
+      @code     = args[:code]
+      @body     = args[:body]
+    end
+  end
+end

data/lib/ecommerce/request.rb

@@ -0,0 +1,49 @@
+module Ecommerce
+  class Request
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      request.run
+      request.response
+    end
+
+    private
+
+    attr_reader :args
+
+    def request
+      @request ||= Typhoeus::Request.new(args[:url], options)
+    end
+
+    def options
+      {
+        method:           args[:method],
+        params:           args[:params],
+        body:             body,
+        headers:          headers,
+        accept_encoding:  "gzip"
+      }.reject {|k,v| v.nil?}
+    end
+
+    def headers
+      headers = args.fetch(:headers) { {} }
+
+      {
+        "Accept"         => "application/json",
+        "Content-Type"   => "application/json",
+        "User-Agent"     => args[:user_agent],
+        "Authorization" => "Basic #{args[:authorization_hash]}"
+      }.merge(headers)
+    end
+
+    def body
+      body = args[:body]
+      body = MultiJson.dump(body) if body.is_a?(Hash)
+      body
+    end
+
+  end
+end

data/lib/ecommerce/resources/base.rb

@@ -0,0 +1,28 @@
+module Ecommerce
+  module Resources
+    class Base
+      def initialize(attribute={})
+        attribute.each do |k, v|
+          set_attribute(k, v)
+        end
+      end
+
+      def self.client
+        Ecommerce.client
+      end
+
+      private
+
+      def self.parsed_body(response)
+        MultiJson.load(response.body)
+      rescue MultiJson::ParseError
+        {}
+      end
+
+      def set_attribute(key, value)
+        object_value = Ecommerce::AttributeHandler.handle(value)
+        instance_variable_set("@#{key}", object_value)
+      end
+    end
+  end
+end

data/lib/ecommerce/resources/order.rb

@@ -0,0 +1,91 @@
+module Ecommerce
+  module Resources
+
+    #
+    # A wrapper to Ecommerce orders API
+    #
+    # [API]
+    #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/index.html
+    #
+
+    class Order < Base
+
+      attr_reader :is_paid, :address_number, :plan_change_urls, :activation_expired, :number, :is_trial,
+                  :address_state, :global_account, :api_url, :document_number, :checkout_url, :active_until,
+                  :charge_day, :address_quarter, :activated_at, :is_active, :user_code, :address, :is_recurring,
+                  :address_city, :plan_slug, :address_complement, :discounts_url, :created_at, :adjustments_url,
+                  :next_payment_at, :amount, :client_email, :client_name, :invoices_url, :zip_code
+
+      #
+      # Creates an Order
+      #
+      # [API]
+      #   Method: <tt>POST /api/orders/:slug/</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#criacao-de-ordem-de-compra
+      #
+
+      def self.create(slug, params)
+        client.post("/api/orders/#{slug}/", { body: params }) do |response|
+          build_order(response)
+        end
+      end
+
+      #
+      # Lists all Orders of a slug and return a collection with orders and pagination information (represented by Ecommerce::Resources::OrderCollection)
+      #
+      # [API]
+      #   Method: <tt>GET /api/orders/:slug/</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#listagem-de-ordens-de-compra
+      #
+
+      def self.find_all(slug, page = 1, limit = 20)
+        client.get("/api/orders/#{slug}/", { body: {page: page, limit: limit} }) do |response|
+          Ecommerce::Resources::OrderCollection.build(response)
+        end
+      end
+
+      #
+      # Finds an Order
+      #
+      # [API]
+      #   Method: <tt>GET /api/orders/:slug/:order_id/</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#detalhes-de-uma-ordem-de-compra
+      #
+
+      def self.find(order_id, slug)
+        client.get("/api/orders/#{slug}/#{order_id}/") do |response|
+          build_order(response)
+        end
+      end
+
+      #
+      # Destroys an Order
+      #
+      # [API]
+      #   Method: <tt>DELETE /api/orders/:slug/:order_id/</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#delete-api-orders-slug-id
+      #
+
+      def self.destroy(order_id, slug)
+        client.delete("/api/orders/#{slug}/#{order_id}/") do |response|
+          build_order(response)
+        end
+      end
+
+      def destroy
+        self.class.destroy(number, plan_slug)
+      end
+
+      private
+
+      def self.build_order(response)
+        order_attributes = parsed_body(response)
+        order_attributes.empty? ? {} : self.new(order_attributes)
+      end
+    end
+  end
+end