ecommerce-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7687281e6e8112b50c562dc4124e6ac17b10f083
-  data.tar.gz: fa8ef5444600d9d6be649eb8ca5742b8f6a983fa
+  metadata.gz: 372faf95c34b3244ee4aa37429bf146c59df0541
+  data.tar.gz: a86671860634547190e26e59d38935ec23949cad
 SHA512:
-  metadata.gz: ed884b916edad83b57c22eef2da3068c711f3cf158f7d4920b86ccef36175442545ed916c0cd407734a65f6d7d40f0a8ff27fd7f82434aef15c90c8cf433de1d
-  data.tar.gz: 96a8edfad2126ba901e4364948de669e0753f5d315992c20f3103efb79c3c7c90d16fa243a81913dc33f4267937b184a5dff9a595b0c5820e7cceb32d5e6f72b
+  metadata.gz: 5af1bcf38deac81ff229e0e654446d9d4c658ca849b47a096c1c5fe8826bd9b843b9c300cfb71eac6f5a471853c4141191628cca22078bc525869534d5a58ead
+  data.tar.gz: f32b025ac5266fd9873bf7512ea7d05541ef6fae88810ea6645f291d63aa28ec61968f6ad598e9c69e4be761a2336e963dec921f8310f9fa182e7ca5f5241e93

data/.gitignore

@@ -28,4 +28,5 @@ mkmf.log
 *~
 .ruby-gemset
 .ruby-version
-doc
+doc
+.rvmrc

data/README.md

@@ -1,6 +1,12 @@
+[![Gem Version](https://badge.fury.io/rb/ecommerce-client.svg)](http://badge.fury.io/rb/ecommerce-client)
+[![Build Status](https://travis-ci.org/myfreecomm/ecommerce-client-ruby.svg?branch=master)](https://travis-ci.org/myfreecomm/ecommerce-client-ruby)
+[![Code Climate](https://codeclimate.com/github/myfreecomm/ecommerce-client-ruby/badges/gpa.svg)](https://codeclimate.com/github/myfreecomm/ecommerce-client-ruby)
+[![Test Coverage](https://codeclimate.com/github/myfreecomm/ecommerce-client-ruby/badges/coverage.svg)](https://codeclimate.com/github/myfreecomm/ecommerce-client-ruby)
+[![Inline docs](http://inch-ci.org/github/myfreecomm/ecommerce-client-ruby.svg)](http://inch-ci.org/github/myfreecomm/ecommerce-client-ruby)
+
 # Ecommerce Client
 
-A Ruby client for Myfreecomm's Ecommerce REST API
+A Ruby client for [Myfreecomm's Ecommerce REST API](http://myfreecomm.github.io/passaporte-web/ecommerce/api/index.html).
 
 ## Installation
 
@@ -16,9 +22,26 @@ Or install it yourself as:
 
     $ gem install ecommerce-client
 
+## Configuration
+
+To access the Ecommerce API, you must provide the *token* and the *secret*:
+
+```ruby
+Ecommerce.configuration do |config|
+  config.token = 'YOUR-TOKEN'
+  config.secret = 'YOUR-SECRET'
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+Ecommerce endpoints are represented as Resources. To check the list of all available Resources, please visit [Ecommerce::Resources](https://github.com/myfreecomm/ecommerce-client-ruby/tree/master/lib/ecommerce/resources) module folder.
+
+```ruby
+# listing orders of a plan
+Ecommerce::Resources::Order.find_all('specific-plan')
+=> #<Ecommerce::Resources::OrderCollection:0x000000028739b0...>
+```
 
 ## Contributing
 

data/ecommerce-client.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', "~> 3.2"
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
 end

data/lib/ecommerce.rb

@@ -7,8 +7,13 @@ require "ecommerce/client"
 require "ecommerce/attribute_handler"
 
 require "ecommerce/resources/base"
+require "ecommerce/resources/collection"
+require "ecommerce/resources/account_order"
 require "ecommerce/resources/order"
 require "ecommerce/resources/order_collection"
+require "ecommerce/resources/invoice_order"
+require "ecommerce/resources/invoice_order_collection"
+require "ecommerce/resources/invoice_plan"
 
 module Ecommerce
   def self.configuration

data/lib/ecommerce/attribute_handler.rb

@@ -48,4 +48,4 @@ module Ecommerce
       DateTime.parse(attribute)
     end
   end
-end
+end

data/lib/ecommerce/resources/account_order.rb

@@ -0,0 +1,26 @@
+module Ecommerce
+  module Resources
+    #
+    # A wrapper to Ecommerce orders API
+    #
+    # [API]
+    #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/index.html
+    #
+    class AccountOrder < Base
+      #
+      # Lists all Orders of an account and return a collection with orders and pagination information (represented by Ecommerce::Resources::Collection)
+      #
+      # [API]
+      #   Method: <tt>GET /api/accounts/:account_uuid/orders/</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#listagem-das-ordens-de-compra-de-uma-conta
+      #
+      def self.find_all(account_uuid, page = 1, limit = 20)
+        body = { page: page, limit: limit }
+        client.get("/api/accounts/#{account_uuid}/orders/", body: body) do |response|
+          Ecommerce::Resources::OrderCollection.build(response)
+        end
+      end
+    end
+  end
+end

data/lib/ecommerce/resources/collection.rb

@@ -0,0 +1,57 @@
+module Ecommerce
+  module Resources
+    #
+    # A wrapper to Ecommerce collection returns from API. This wrapper represents a collection and it's responsible for processing pagination information as well.
+    #
+    class Collection < Base
+      PAGE_REGEX = /page=(\d+)/
+
+      attr_reader :response, :collection, :headers
+
+      def initialize(response)
+        @response = response
+        @collection = []
+        @headers = response.headers['Link'].split(',')
+      end
+
+      def self.build(response)
+        self.new(response).build
+      end
+
+      def build
+        build_collection
+        self
+      end
+
+      def next_page
+        page_for(:next)
+      end
+
+      def last_page
+        page_for(:last)
+      end
+
+      def previous_page
+        page_for(:prev)
+      end
+
+      def first_page
+        page_for(:first)
+      end
+
+      private
+
+      def page_for(page_rel)
+        header_link_for(page_rel).match(PAGE_REGEX)[1].to_i rescue nil
+      end
+
+      def header_link_for(rel)
+        headers.select{|n| n =~ /rel=#{rel}/}.first
+      end
+
+      def build_collection
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/ecommerce/resources/invoice_order.rb

@@ -0,0 +1,52 @@
+module Ecommerce
+  module Resources
+    #
+    # A wrapper to Ecommerce orders invoice API
+    #
+    # [API]
+    #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/index.html
+    #
+    class InvoiceOrder < Base
+      attr_reader :redeemed_adjustments, :order_url, :url, :created_at, :activated_at, :number, :user_data,
+                  :amount_with_adjustments, :amount, :paid, :payment_method, :plan_data, :charge_date,
+                  :next_payment_date
+
+      #
+      # Lists all invoice of an orders and return a collection of invoice with
+      # pagination information (represented by Ecommerce::Resources::InvoiceOrderCollection)
+      #
+      # [API]
+      #   Method: <tt>GET /api/orders/:slug/:id/invoices/ </tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#listagem-das-ordens-de-compra-de-uma-conta
+      #
+      def self.find_all(order_id, slug, page = 1, limit = 20)
+        body = { page: page, limit: limit }
+        client.get("/api/orders/#{slug}/#{order_id}/invoices/", body: body) do |response|
+          Ecommerce::Resources::InvoiceOrderCollection.build(response)
+        end
+      end
+
+      #
+      # Finds an invoice of an order
+      #
+      # [API]
+      #   Method: <tt>GET /api/orders/:slug/:order_id/invoices/:id/</tt>
+      #
+      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#listagem-das-ordens-de-compra-de-uma-conta
+      #
+      def self.find(invoice_order_id, order_id, slug)
+        client.get("/api/orders/#{slug}/#{order_id}/invoices/#{invoice_order_id}/") do |response|
+          build_invoice(response)
+        end
+      end
+
+      private
+
+      def self.build_invoice(response)
+        invoice_attributes = parsed_body(response)
+        invoice_attributes.empty? ? {} : new(invoice_attributes)
+      end
+    end
+  end
+end

data/lib/ecommerce/resources/invoice_order_collection.rb

@@ -0,0 +1,20 @@
+module Ecommerce
+  module Resources
+    #
+    # A wrapper to Ecommerce orders API.
+    #
+    class InvoiceOrderCollection < Collection
+      def orders
+        collection
+      end
+
+      private
+
+      def build_collection
+        Ecommerce::Resources::Base.parsed_body(response).each do |invoice_attributes|
+          collection.push(Ecommerce::Resources::InvoiceOrder.new(invoice_attributes))
+        end
+      end
+    end
+  end
+end

data/lib/ecommerce/resources/invoice_plan.rb

@@ -0,0 +1,27 @@
+module Ecommerce
+  module Resources
+    #
+    # A wrapper to Ecommerce invoice per plan API
+    #
+    # [API]
+    #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/index.html
+    #
+    class InvoicePlan < Base
+      #
+      # Lists all paid invoices of a plan and return a collection of invoice with 
+      # pagination information (represented by Ecommerce::Resources::InvoiceOrderCollection)
+      #
+      # [API]
+      #   Method: <tt>GET /api/:slug/invoices/paid/
+      #
+      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#listagem-das-faturas-pagas-para-um-plano
+      #
+      def self.find_all(slug, page = 1, limit = 20)
+        body = { page: page, limit: limit }
+        client.get("/api/#{slug}/invoices/paid/", body: body) do |response|
+          Ecommerce::Resources::InvoiceOrderCollection.build(response)
+        end
+      end
+    end
+  end
+end

data/lib/ecommerce/resources/order.rb

@@ -1,15 +1,12 @@
 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,
@@ -24,24 +21,24 @@ module Ecommerce
       #
       #   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|
+        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)
+      # 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|
+        body = { page: page, limit: limit }
+        client.get("/api/orders/#{slug}/", body: body) do |response|
           Ecommerce::Resources::OrderCollection.build(response)
         end
       end
@@ -54,7 +51,6 @@ module Ecommerce
       #
       #   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)
@@ -69,22 +65,31 @@ module Ecommerce
       #
       #   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)
+      #
+      # Updates an Order client information
+      #
+      # [API]
+      #   Method: <tt>PUT /api/orders/:slug/:order_id/</tt>
+      #
+      #   Documentation for available and required fields: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#put-api-orders-slug-id
+      #
+      def self.update(order_id, slug, order_params={})
+        client.put("/api/orders/#{slug}/#{order_id}/", body: order_params) do |response|
+          build_order(response)
+        end
       end
 
       private
 
       def self.build_order(response)
         order_attributes = parsed_body(response)
-        order_attributes.empty? ? {} : self.new(order_attributes)
+        order_attributes.empty? ? {} : new(order_attributes)
       end
     end
   end

data/lib/ecommerce/resources/order_collection.rb

@@ -1,60 +1,18 @@
 module Ecommerce
   module Resources
-
     #
-    # A wrapper to Ecommerce orders API. This wrapper represents a collection of orders and it's responsible for processing pagination information as well.
+    # A wrapper to Ecommerce orders API.
     #
-
-    class OrderCollection < Base
-
-      PAGE_REGEX = /page=(\d+)/
-
-      attr_reader :response, :orders, :headers
-
-      def initialize(response)
-        @response = response
-        @orders = []
-        @headers = response.headers['Link'].split(',')
-      end
-
-      def self.build(response)
-        self.new(response).build
-      end
-
-      def build
-        build_orders
-        self
-      end
-
-      def next_page
-        page_for(:next)
-      end
-
-      def last_page
-        page_for(:last)
-      end
-
-      def previous_page
-        page_for(:prev)
-      end
-
-      def first_page
-        page_for(:first)
+    class OrderCollection < Collection
+      def orders
+        collection
       end
 
       private
 
-      def page_for(page_rel)
-        header_link_for(page_rel).match(PAGE_REGEX)[1].to_i rescue nil
-      end
-
-      def header_link_for(rel)
-        headers.select{|n| n =~ /rel=#{rel}/}.first
-      end
-
-      def build_orders
+      def build_collection
         Ecommerce::Resources::Base.parsed_body(response).each do |order_attributes|
-          orders.push(Ecommerce::Resources::Order.new(order_attributes))
+          collection.push(Ecommerce::Resources::Order.new(order_attributes))
         end
       end
     end

data/lib/ecommerce/version.rb

@@ -1,3 +1,3 @@
 module Ecommerce
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/ecommerce/attribute_handler_spec.rb

@@ -49,6 +49,30 @@ describe Ecommerce::AttributeHandler do
           expect(subject.handle).to eq(DateTime.new(2014, 6, 1, 14, 17, 56))
         end
       end
+
+      context 'when parameter is nil' do
+        subject { Ecommerce::AttributeHandler.new(nil) }
+
+        it 'returns parameter' do
+          expect(subject.handle).to be_nil
+        end
+      end
+
+      context 'when parameter is blank' do
+        subject { Ecommerce::AttributeHandler.new('') }
+
+        it 'returns parameter' do
+          expect(subject.handle).to eq('')
+        end
+      end
+
+      context 'when parameter is different from String' do
+        subject { Ecommerce::AttributeHandler.new([]) }
+
+        it 'returns parameter' do
+          expect(subject.handle).to eq([])
+        end
+      end
     end
   end
 end