invoiced 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3d0fb6df2dfd4f928568d4ea0a83e3d53ce4919
-  data.tar.gz: e44d50f6ff6a414581a232822a0f102c34735a9c
+  metadata.gz: 5997cf1ddd23e0cece25a26780c348354a672b9c
+  data.tar.gz: 7f0a09349c1b87b9cfb11c8afbdf6533a566cdd2
 SHA512:
-  metadata.gz: 2e35188dfb36506e37d4f7e2843e04f14bf99ba5760a1a4787ef8a81164cf583709e5f78e0a3a060afa3f3de453c234be5b00c8d827a9021845acbbbf1f601d0
-  data.tar.gz: 6cffd338a583376971c154eaa14d30ba4602189b60bb674abce145aa9329777eb72ed090428f058fece46ac051b4c7d05cf8344fd0e1ef3bffa503f3c0fb21f7
+  metadata.gz: cf0aa2c91593969dfe034a8f6f5db01fe6e7ee7164c0327ddd67de29c968b2378311af6ccbae253d90f75be240491cda23fa8bb3d3b09bc351ef9ce2a27cabdf
+  data.tar.gz: 9c936769e5d820574fdfef68e508454c1aa0fba468a602bfc4bc1e49edba3dcad2a2d4f8ca27fe92d2f2a546d6a55a45ecf58783b1bcfcb8541cbb43cf95dca4

data/invoiced.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.email       = 'support@invoiced.com'
   s.files       = ["lib/invoiced.rb"]
   s.homepage    = 'https://invoiced.com/docs/dev'
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.0.0'
 
   s.add_dependency('rest-client', '~> 2.0.0')
   s.add_dependency('json', '~> 1.8.3')

data/lib/invoiced/credit_note.rb

@@ -5,16 +5,16 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        def send(opts={})
-            response = @client.request(:post, "#{self.endpoint()}/emails", opts)
+        def send(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
             # build email objects
             email = Email.new(@client)
             Util.build_objects(email, response[:body])
         end
 
-        def attachments(opts={})
-            response = @client.request(:get, "#{self.endpoint()}/attachments", opts)
+        def attachments(params={})
+            response = @client.request(:get, "#{self.endpoint()}/attachments", params)
 
             # ensure each attachment has an ID
             body = response[:body]

data/lib/invoiced/customer.rb

@@ -5,8 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        def send_statement(opts={})
-            response = @client.request(:post, "#{self.endpoint()}/emails", opts)
+        def send_statement(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
             # build email objects
             email = Email.new(@client)
@@ -19,18 +19,18 @@ module Invoiced
             response[:body]
         end
 
-        def contacts(opts={})
+        def contacts()
             contact = Contact.new(@client)
             contact.set_endpoint_base(self.endpoint())
         end
 
-        def line_items(opts={})
+        def line_items()
             line = LineItem.new(@client)
             line.set_endpoint_base(self.endpoint())
         end
 
-        def invoice(opts={})
-            response = @client.request(:post, "#{self.endpoint()}/invoices", opts)
+        def invoice(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/invoices", params, opts)
 
             # build invoice object
             invoice = Invoice.new(@client)

data/lib/invoiced/estimate.rb

@@ -5,24 +5,24 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        def send(opts={})
-            response = @client.request(:post, "#{self.endpoint()}/emails", opts)
+        def send(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
             # build email objects
             email = Email.new(@client)
             Util.build_objects(email, response[:body])
         end
 
-        def generate_invoice(opts={})
-            response = @client.request(:post, "#{self.endpoint()}/invoice", opts)
+        def generate_invoice(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/invoice", params, opts)
 
             # build invoice object
             invoice = Invoice.new(@client)
             Util.convert_to_object(invoice, response[:body])
         end
 
-        def attachments(opts={})
-            response = @client.request(:get, "#{self.endpoint()}/attachments", opts)
+        def attachments(params={})
+            response = @client.request(:get, "#{self.endpoint()}/attachments", params)
 
             # ensure each attachment has an ID
             body = response[:body]

data/lib/invoiced/invoice.rb

@@ -5,16 +5,16 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        def send(opts={})
-            response = @client.request(:post, "#{self.endpoint()}/emails", opts)
+        def send(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
             # build email objects
             email = Email.new(@client)
             Util.build_objects(email, response[:body])
         end
 
-        def pay
-            response = @client.request(:post, "#{self.endpoint()}/pay")
+        def pay(opts={})
+            response = @client.request(:post, "#{self.endpoint()}/pay", {}, opts)
 
             # update the local values with the response
             refresh_from(response[:body].dup.merge({:id => self.id}))
@@ -22,8 +22,8 @@ module Invoiced
             return response[:code] == 200
         end
 
-        def attachments(opts={})
-            response = @client.request(:get, "#{self.endpoint()}/attachments", opts)
+        def attachments(params={})
+            response = @client.request(:get, "#{self.endpoint()}/attachments", params)
 
             # ensure each attachment has an ID
             body = response[:body]
@@ -43,7 +43,7 @@ module Invoiced
             return attachments, metadata
         end
 
-        def payment_plan(opts={})
+        def payment_plan()
             paymentPlan = PaymentPlan.new(@client)
             paymentPlan.set_endpoint_base(self.endpoint())
         end

data/lib/invoiced/object.rb

@@ -35,19 +35,16 @@ module Invoiced
             @endpoint_base + @endpoint
         end
 
-        def retrieve(id, opts={})
+        def retrieve(id, params={})
             if !id
                 raise ArgumentError.new("Missing ID.")
             end
 
-            response = @client.request(:get, "#{self.endpoint()}/#{id}", opts)
+            response = @client.request(:get, "#{self.endpoint()}/#{id}", params)
 
             Util.convert_to_object(self, response[:body])
         end
 
-        def load(opts={})
-        end
-
         def to_s(*args)
             JSON.pretty_generate(@values)
         end

data/lib/invoiced/operations/create.rb

@@ -1,8 +1,8 @@
 module Invoiced
     module Operations
         module Create
-            def create(body={})
-                response = @client.request(:post, self.endpoint(), body)
+            def create(body={}, opts={})
+                response = @client.request(:post, self.endpoint(), body, opts)
 
                 Util.convert_to_object(self, response[:body])
             end

data/lib/invoiced/operations/list.rb

@@ -1,8 +1,8 @@
 module Invoiced
     module Operations
         module List
-            def list(opts={})
-                response = @client.request(:get, self.endpoint(), opts)
+            def list(params={})
+                response = @client.request(:get, self.endpoint(), params)
 
                 # build objects
                 objects = Util.build_objects(self, response[:body])

data/lib/invoiced/operations/update.rb

@@ -1,7 +1,7 @@
 module Invoiced
     module Operations
         module Update
-            def save(params = {})
+            def save(params={}, opts={})
                 update = {}
 
                 @unsaved.each do |k|
@@ -12,7 +12,7 @@ module Invoiced
 
                 # perform the update if there are any changes
                 if update.length > 0
-                    response = @client.request(:patch, self.endpoint(), update)
+                    response = @client.request(:patch, self.endpoint(), update, opts)
 
                     # update the local values with the response
                     refresh_from(response[:body].dup.merge({:id => self.id}))

data/lib/invoiced/payment_plan.rb

@@ -7,14 +7,14 @@ module Invoiced
         	@endpoint = '/payment_plan'
         end
 
-        def create(body={})
-            response = @client.request(:put, self.endpoint(), body)
+        def create(params={}, opts={})
+            response = @client.request(:put, self.endpoint(), params, opts)
 
             Util.convert_to_object(self, response[:body])
         end
 
-        def retrieve(opts={})
-            response = @client.request(:get, self.endpoint(), opts)
+        def retrieve(params={})
+            response = @client.request(:get, self.endpoint(), params)
 
             Util.convert_to_object(self, response[:body])
         end

data/lib/invoiced/transaction.rb

@@ -5,16 +5,16 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        def send(opts={})
-            response = @client.request(:post, "#{self.endpoint()}/emails", opts)
+        def send(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 
             # build email objects
             email = Email.new(@client)
             Util.build_objects(email, response[:body])
         end
 
-        def refund(opts={})
-            response = @client.request(:post, "#{self.endpoint()}/refunds", opts)
+        def refund(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/refunds", params, opts)
 
             Util.convert_to_object(self, response[:body])
         end

data/lib/invoiced/version.rb

@@ -1,3 +1,3 @@
 module Invoiced
-  VERSION = '0.11.2'
+  VERSION = '0.12.0'
 end

data/lib/invoiced.rb

@@ -63,7 +63,7 @@ module Invoiced
           @Transaction = Invoiced::Transaction.new(self)
         end
 
-        def request(method, endpoint, params={})
+        def request(method, endpoint, params={}, opts={})
             url = @api_url + endpoint
 
             case method.to_s.downcase.to_sym
@@ -81,11 +81,7 @@ module Invoiced
                 response = RestClient::Request.execute(
                     :method => method,
                     :url => url,
-                    :headers => {
-                        :authorization => Util.auth_header(@api_key),
-                        :content_type => "application/json",
-                        :user_agent => "Invoiced Ruby/#{Invoiced::VERSION}"
-                    },
+                    :headers => buildHeaders(opts),
                     :payload => payload,
                     :open_timeout => OpenTimeout,
                     :timeout => ReadTimeout
@@ -103,6 +99,21 @@ module Invoiced
 
         private
 
+        def buildHeaders(opts)
+            headers = {
+                :authorization => Util.auth_header(@api_key),
+                :content_type => "application/json",
+                :user_agent => "Invoiced Ruby/#{Invoiced::VERSION}"
+            }
+
+            # idempotency keys
+            if opts[:idempotency_key]
+                headers[:idempotency_key] = opts[:idempotency_key]
+            end
+
+            return headers
+        end
+
         def parse(response)
             unless response.code == 204
                 parsed_response = JSON.parse(response.body, :symbolize_names => true)
@@ -139,7 +150,7 @@ module Invoiced
         def handle_network_error(error)
             case error
             when RestClient::Exceptions::OpenTimeout
-                message = "Timeed out while connecting to Invoiced. Please check your internet connection or status.invoiced.com for service outages."
+                message = "Timed out while connecting to Invoiced. Please check your internet connection or status.invoiced.com for service outages."
             when RestClient::Exceptions::ReadTimeout
                 message = "The request timed out reading data from the server."
             when RestClient::ServerBrokeConnection

data/test/invoiced/invoiced_test.rb

@@ -93,6 +93,40 @@ module Invoiced
       assert_equal(expectedResponse, response)
     end
 
+    should "perform an idempotent post request" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(204)
+      mockResponse.stubs(:headers).returns({})
+
+      # not used
+      # expectedParameters = {
+      #   :method => "POST",
+      #   :url => "https://api.invoiced.com/invoices?test=property&filter[levels]=work",
+      #   :headers => {
+      #     :authorization => "Basic dGVzdDo=",
+      #     :content_type => "application/json",
+      #     :user_agent => "Invoiced Ruby/#{Invoiced::VERSION}"
+      #     :idempotency_key => "a random value"
+      #   },
+      #   :payload => '{"test":"property"}'
+      # }
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      client = Invoiced::Client.new('test')
+      params = {
+        "test" => "property"
+      }
+      response = client.request("POST", "/invoices", params, {:idempotency_key => "a random value"})
+
+      expectedResponse = {
+        :code => 204,
+        :headers => {},
+        :body => nil
+      }
+      assert_equal(expectedResponse, response)
+    end
+
     should "handle a generic network error" do
       RestClient::Request.any_instance.expects(:execute).raises(RestClient::Exception.new)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoiced
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Jared King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -181,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="