intelipost 0.0.6 → 0.0.7

data/README.md

@@ -9,28 +9,41 @@ Gem for the Intelipost API
 
 ### Usage:
 
+#### Address Complete (CEP)
+
 ````ruby
 # GET /cep_address/complete
 require 'intelipost'
 
 client = Intelipost::Client.new api_key: <your api key>
-address = client.cep.address_complete '05307000'
+address = client.cep.address_complete.get '05307000'
 # => #<Hashie::Mash content=#<Hashie::Mash bairro="Vila Ribeiro de Barros" city="São Paulo" ibge="3550308" neighborhood="Vila Ribeiro de Barros" state="São Paulo" state_short="SP" street="R Maj Paladino"> messages=[] status="OK" time="0.6 ms">
 address.content.street
 # => "R Maj Paladino"
 ````
 
+#### Quote (Cotação)
+
 ````ruby
 # POST /quote
 require 'intelipost'
 
 client = Intelipost::Client.new api_key: <your api key>
-quote = client.quote.create({hash_of :intelipost, required: :args})
+quote = client.quote.create({hash_of: :intelipost, args: :values})
 # => #<Hashie::Mash content=#<Hashie::Mash additional_information=#<Hashie::Mash client_type="gold" delivery_method_ids=[4, 3, 2] extra_cost_absolute=0.0 extra_cost_percentage=0.0 free_shipping=false lead_time_business_days=0 sales_channel="hotsite" tax_id=nil> client_id=1783 created=1433872646799 created_iso="2015-06-09T14:57:26.799-03:00" delivery_options=[#<Hashie::Mash delivery_estimate_business_days=1 delivery_method_id=4 delivery_method_name="Total Express" delivery_method_type="EXPRESS" delivery_note=nil description="Total Express" final_shipping_cost=5.05 logistic_provider_name="Total" provider_shipping_cost=5.05>, #<Hashie::Mash delivery_estimate_business_days=1 delivery_method_id=3 delivery_method_name="Correios eSedex" delivery_method_type="EXPRESS" delivery_note=nil description="Correios eSedex" final_shipping_cost=7.83 logistic_provider_name="Correios" provider_shipping_cost=7.83>, #<Hashie::Mash delivery_estimate_business_days=1 delivery_method_id=2 delivery_method_name="Correios Sedex" delivery_method_type="EXPRESS" delivery_note=nil description="Correios Sedex" final_shipping_cost=13.83 logistic_provider_name="Correios" provider_shipping_cost=13.83>] destination_zip_code="06396-200" id=4347667 origin_zip_code="04037-003" platform=nil volumes=[#<Hashie::Mash cost_of_goods=100.0 description=nil height=10.0 length=10.0 volume_type="BOX" weight=0.1 width=10.0>]> messages=[] status="OK" time="34.0 ms">
 quote.content.id
 # => 4347667
 ````
 
+````ruby
+# GET /quote/{id}
+require 'intelipost'
+client = Intelipost::Client.new api_key: <your api key>
+quote = client.quote.get(124560)
+````
+
+#### Shipment Order (Pedido de Envio)
+
 ````ruby
 # POST /shipment_order
 require 'intelipost'
@@ -39,6 +52,30 @@ client = Intelipost::Client.new api_key: <your api key>
 client.shipment_order.create({hash_of: :intelipost, args: :values})
 ````
 
+````ruby
+# POST /shipment_order/set_invoice
+require 'intelipost'
+
+client = Intelipost::Client.new api_key: <your api key>
+client.shipment_order.set_invoice.update({hash_of: :intelipost, args: :values})
+````
+
+````ruby
+# POST /shipment_order/set_tracking_data
+require 'intelipost'
+
+client = Intelipost::Client.new api_key: <your api key>
+client.shipment_order.set_tracking_data.update({hash_of: :intelipost, args: :values})
+````
+
+````ruby
+# GET /shipment_order/read_status/{order_number}
+require 'intelipost'
+
+client = Intelipost::Client.new api_key: <your api key>
+client.shipment_order.read_status.get(124560)
+````
+
 ### Development:
 
 For testing, create a `.env` file with the following content:

data/lib/intelipost/fluent_interface.rb

@@ -1,5 +1,32 @@
 module Intelipost
   module FluentInterface
+
+    def self.included(cls)
+      cls.extend(ClassMethods)
+    end
+
+    def create(post_values)
+      connection.post(@fluent_interfaces.join('/'), post_values)
+    end
+
+    def update(post_values)
+      create(post_values)
+    end
+
+    def get(value)
+      connection.get([@fluent_interfaces, value].join('/'))
+    end
+
+    def method_missing(method, *args, &block)
+      add_fluent_interface_path(method)
+      self
+    end
+
+    private
+    def add_fluent_interface_path(method)
+      @fluent_interfaces << method
+    end
+
     module ClassMethods
       def set_endpoint endpoint
         define_method :endpoint do
@@ -7,29 +34,15 @@ module Intelipost
         end
       end
     end
-
-    module InstanceMethods
-      def create(post_values)
-        connection.post(endpoint, post_values)
-      end
-
-      def method_missing(method, *args, &block)
-        connection.get [endpoint, method, args].join '/'
-      end
-    end
   end
 
   class FluentInterfaceBase
-    extend Intelipost::FluentInterface::ClassMethods
-    include Intelipost::FluentInterface::InstanceMethods
+    include Intelipost::FluentInterface
     attr_accessor :connection
 
     def initialize(connection)
       @connection = connection
-    end
-
-    def spawn
-      clone
+      @fluent_interfaces = [endpoint]
     end
   end
 end

data/lib/intelipost/version.rb

@@ -1,3 +1,3 @@
 module Intelipost
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/lib/intelipost/cep_spec.rb

@@ -4,7 +4,7 @@ describe Intelipost::Cep do
   describe '#address_complete' do
     it 'correctly queries the cep' do
       expect(subject.connection).to receive(:get).with('cep_location/address_complete/00000000')
-      subject.address_complete '00000000'
+      subject.address_complete.get '00000000'
     end
   end
 end

data/spec/lib/intelipost/client_spec.rb

@@ -19,6 +19,12 @@ describe Intelipost::Client, :vcr do
     end
   end
 
+  context 'when call for an non existing defined class' do
+    it '.method_missing' do
+      expect { subject.foobar(1) }.to raise_error ArgumentError
+    end
+  end
+
   context 'initialized with credentials' do
     describe '#connection' do
       it 'is an instance of Faraday::Connection' do
@@ -39,11 +45,11 @@ describe Intelipost::Client, :vcr do
 
   context 'dealing with zipcode (cep)' do
     it 'returns a Hashie::Mash on successful query' do
-      expect(subject.cep.address_complete('04661100').class).to be Hashie::Mash
+      expect(subject.cep.address_complete.get('04661100').class).to eq Hashie::Mash
     end
   end
 
-  context 'request quotations' do
+  context 'dealing with Quotes' do
     let(:volumes) do
       {
         'origin_zip_code' => '04037-003',
@@ -77,5 +83,10 @@ describe Intelipost::Client, :vcr do
     it '.quote.create' do
       expect(subject.quote.create(volumes)).to have_key(:content)
     end
+
+    it '.quote.get(#)' do
+      quote_id = subject.quote.create(volumes).content.id
+      expect(subject.quote.get(quote_id)).to have_key(:content)
+    end
   end
 end

data/spec/lib/intelipost/quote_spec.rb

@@ -35,4 +35,10 @@ describe Intelipost::Quote do
     expect(subject.connection).to receive(:post).with('quote', volumes)
     subject.create(volumes)
   end
+
+  it 'will pull an existing quote by its id' do
+    id = 99
+    expect(subject.connection).to receive(:get).with("quote/#{id}")
+    subject.get(99)
+  end
 end

data/spec/lib/intelipost/shipment_order_spec.rb

@@ -58,4 +58,54 @@ describe Intelipost::ShipmentOrder do
     expect(subject.connection).to receive(:post).with('shipment_order', order_to_ship)
     subject.create(order_to_ship)
   end
+
+  let(:order_invoice) do
+    {
+      'order_number' => '12314324',
+      'shipment_order_volume_invoice_array' => [
+        {
+          'shipment_order_volume_number' => '1',
+          'invoice_series' => '123123123',
+          'invoice_number' => 'BR283248123',
+          'invoice_key' => 'CDFx2342396078192310231982',
+          'invoice_date' => '2014-02-28',
+          'invoice_total_value' => '32,49',
+          'invoice_products_value' => '28,99',
+          'invoice_cfop' => '5120'
+        }
+      ]
+    }
+  end
+
+  it 'invoice update' do
+    expect(subject.connection).to receive(:post).with('shipment_order/set_invoice', order_invoice)
+    subject.set_invoice.update(order_invoice)
+  end
+
+  let(:order_tracking_code) do
+    {
+      'order_number' => 'BR12345',
+      'tracking_data_array' => [
+      {
+        'shipment_order_volume_number' => 1,
+        'tracking_code' => 'SW123456789BR'
+      },
+      {
+        'shipment_order_volume_number' => 2,
+        'tracking_code' => 'SW123456789BR'
+      }
+      ]
+    }
+  end
+
+  it 'tracking update' do
+    expect(subject.connection).to receive(:post).with('shipment_order/set_tracking_data', order_tracking_code)
+    subject.set_tracking_data.update(order_tracking_code)
+  end
+
+  it 'read status from API' do
+    order_id = 128492394
+    expect(subject.connection).to receive(:get).with("shipment_order/read_status/#{order_id}")
+    subject.read_status.get(order_id)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intelipost
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday