invoiced 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc29d5e9ff33831248d574c23a30169f149ba7b9ed11d2904de174cabba75163
-  data.tar.gz: 4f2b87a74c4a58dffcadd4b46855089ac928a655f4b11e5e07598ea940d5e4b7
+  metadata.gz: 3c9a2f8ec999dc38fc2d99a9a6c70ed9f908453399e7a1391b139f08d0016c58
+  data.tar.gz: bded9ce98e08adf08061d9411958f358c2a53622f1c6df96ddbdee4ea34c02b8
 SHA512:
-  metadata.gz: c3ba71d623fd4714ecd4975d29a7aa9730ceb8be5daaf8e7324eace2af003e6a986bab11bc83312cbb2316799ebdbfc922fa48b456ab6bb919c61608c33f04af
-  data.tar.gz: eb098797e875032bd88e01452bdb2794cbdec350973ed46fb9ce06c3118b0355b2465643b8ec4aaae3212be46715e7f470826a27b0a2d0bf0c855412873afe8b
+  metadata.gz: cce64c5c13a67dcfb8d1b693fa915e3927b9785a4f27c9a19dd72c0c36e9b97ad17b1159a0023994d73562e90d8cd0384f51704c890e8f2e849d9e8b9f1a3800
+  data.tar.gz: 9763afc75104c54d36b1a31cf603d9fd13d8a777b17f3d871cb59eadc8b80fa1e0ebfd2bdfd68de52110e27fd6a35c73a29c4f34fafc0b647386a6073bb17b91

data/.travis.yml

@@ -5,6 +5,9 @@ rvm:
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 
 sudo: false
 

data/README.md

@@ -5,6 +5,7 @@ This repository contains the Ruby client library for the [Invoiced](https://invo
 
 [![Build Status](https://travis-ci.org/Invoiced/invoiced-ruby.svg?branch=master)](https://travis-ci.org/Invoiced/invoiced-ruby)
 [![Coverage Status](https://coveralls.io/repos/Invoiced/invoiced-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/Invoiced/invoiced-ruby?branch=master)
+[![Gem Version](https://badge.fury.io/rb/invoiced.svg)](https://badge.fury.io/rb/invoiced)
 
 ## Installing
 

data/lib/invoiced.rb

@@ -23,6 +23,7 @@ require 'invoiced/attachment'
 require 'invoiced/bank_account'
 require 'invoiced/card'
 require 'invoiced/catalog_item'
+require 'invoiced/charge'
 require 'invoiced/contact'
 require 'invoiced/coupon'
 require 'invoiced/credit_note'
@@ -35,9 +36,11 @@ require 'invoiced/invoice'
 require 'invoiced/letter'
 require 'invoiced/line_item'
 require 'invoiced/note'
+require 'invoiced/payment'
 require 'invoiced/payment_plan'
 require 'invoiced/payment_source'
 require 'invoiced/plan'
+require 'invoiced/refund'
 require 'invoiced/subscription'
 require 'invoiced/task'
 require 'invoiced/tax_rate'
@@ -53,7 +56,7 @@ module Invoiced
         ReadTimeout = 80
 
         attr_reader :api_key, :api_url, :sandbox, :sso_key
-        attr_reader :CatalogItem, :Coupon, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Note, :Plan, :Subscription, :Task, :TaxRate, :Transaction
+        attr_reader :CatalogItem, :Charge, :Coupon, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Note, :Payment, :Plan, :Refund, :Subscription, :Task, :TaxRate, :Transaction
 
         def initialize(api_key, sandbox=false, sso_key=false)
           @api_key = api_key
@@ -63,6 +66,7 @@ module Invoiced
 
           # Object endpoints
           @CatalogItem = Invoiced::CatalogItem.new(self)
+          @Charge = Invoiced::Charge.new(self)
           @Coupon = Invoiced::Coupon.new(self)
           @CreditNote = Invoiced::CreditNote.new(self)
           @Customer = Invoiced::Customer.new(self)
@@ -71,7 +75,9 @@ module Invoiced
           @File = Invoiced::File.new(self)
           @Invoice = Invoiced::Invoice.new(self)
           @Note = Invoiced::Note.new(self)
+          @Payment = Invoiced::Payment.new(self)
           @Plan = Invoiced::Plan.new(self)
+          @Refund = Invoiced::Refund.new(self)
           @Subscription = Invoiced::Subscription.new(self)
           @Task = Invoiced::Task.new(self)
           @TaxRate = Invoiced::TaxRate.new(self)

data/lib/invoiced/charge.rb

@@ -0,0 +1,12 @@
+module Invoiced
+    class Charge < Object
+        OBJECT_NAME = 'charge'
+
+        def create(body={}, opts={})
+            response = @client.request(:post, endpoint(), body, opts)
+
+            payment = Payment.new(@client)
+            Util.convert_to_object(payment, response[:body])
+        end
+    end
+end

data/lib/invoiced/payment.rb

@@ -0,0 +1,18 @@
+module Invoiced
+    class Payment < Object
+        include Invoiced::Operations::List
+        include Invoiced::Operations::Create
+        include Invoiced::Operations::Update
+        include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'payment'
+
+        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
+    end
+end

data/lib/invoiced/refund.rb

@@ -0,0 +1,11 @@
+module Invoiced
+    class Refund < Object
+        OBJECT_NAME = 'refund'
+
+        def create(chargeId, body={}, opts={})
+            response = @client.request(:post, @endpoint_base + "/charges/#{chargeId}/refunds", body, opts)
+
+            Util.convert_to_object(self, response[:body])
+        end
+    end
+end

data/lib/invoiced/version.rb

@@ -1,3 +1,3 @@
 module Invoiced
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/test/invoiced/charge_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class ChargeTest < Test::Unit::TestCase
+    should "return the api endpoint" do
+      charge = Charge.new(@client, 123)
+      assert_equal('/charges/123', charge.endpoint())
+    end
+
+    should "create a charge" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":"a1b2c3","amount":100,"object":"charge"}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      charge = Charge.new(@client, 1234)
+      charge = charge.create(:amount => 100, :payment_source_type => "card")
+
+      assert_instance_of(Invoiced::Payment, charge)
+      assert_equal(charge.id, "a1b2c3")
+    end
+  end
+end

data/test/invoiced/payment_test.rb

@@ -0,0 +1,107 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class PaymentTest < Test::Unit::TestCase
+    should "return the api endpoint" do
+      payment = Payment.new(@client, 123)
+      assert_equal('/payments/123', payment.endpoint())
+    end
+
+    should "create a payment" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":123,"amount":100}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      payment = @client.Payment.create({:amount => 800})
+
+      assert_instance_of(Invoiced::Payment, payment)
+      assert_equal(123, payment.id)
+      assert_equal(100, payment.amount)
+    end
+
+    should "retrieve a payment" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":123,"amount":100}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      payment = @client.Payment.retrieve(123)
+
+      assert_instance_of(Invoiced::Payment, payment)
+      assert_equal(123, payment.id)
+      assert_equal(100, payment.amount)
+    end
+
+    should "not update a payment when no params" do
+      payment = Payment.new(@client, 123)
+      assert_false(payment.save)
+    end
+
+    should "update a payment" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('{"id":123,"sent":true}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      payment = Payment.new(@client, 123)
+      payment.sent = true
+      assert_true(payment.save)
+
+      assert_true(payment.sent)
+    end
+
+    should "list all payments" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(200)
+      mockResponse.stubs(:body).returns('[{"id":123,"amount":100}]')
+      mockResponse.stubs(:headers).returns(:x_total_count => 15, :link => '<https://api.invoiced.com/payments?per_page=25&page=1>; rel="self", <https://api.invoiced.com/payments?per_page=25&page=1>; rel="first", <https://api.invoiced.com/payments?per_page=25&page=1>; rel="last"')
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      payments, metadata = @client.Payment.list
+
+      assert_instance_of(Array, payments)
+      assert_equal(1, payments.length)
+      assert_equal(123, payments[0].id)
+
+      assert_instance_of(Invoiced::List, metadata)
+      assert_equal(15, metadata.total_count)
+    end
+
+    should "delete a payment" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(204)
+      mockResponse.stubs(:body).returns('')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      payment = Payment.new(@client, 123)
+      assert_true(payment.delete)
+    end
+
+    should "send a payment receipt" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('[{"id":4567,"email":"test@example.com"}]')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      payment = Payment.new(@client, 1234)
+      emails = payment.send
+
+      assert_instance_of(Array, emails)
+      assert_equal(1, emails.length)
+      assert_instance_of(Invoiced::Email, emails[0])
+      assert_equal(4567, emails[0].id)
+    end
+  end
+end

data/test/invoiced/refund_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Invoiced
+  class RefundTest < Test::Unit::TestCase
+    should "return the api endpoint" do
+      refund = Refund.new(@client, 123)
+      assert_equal('/refunds/123', refund.endpoint())
+    end
+
+    should "create a refund" do
+      mockResponse = mock('RestClient::Response')
+      mockResponse.stubs(:code).returns(201)
+      mockResponse.stubs(:body).returns('{"id":456}')
+      mockResponse.stubs(:headers).returns({})
+
+      RestClient::Request.any_instance.expects(:execute).returns(mockResponse)
+
+      refund = Refund.new(@client, 1234)
+      refund = refund.create(456, {:amount => 800})
+
+      assert_instance_of(Invoiced::Refund, refund)
+      assert_equal(456, refund.id)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoiced
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jared King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -56,6 +56,7 @@ files:
 - lib/invoiced/bank_account.rb
 - lib/invoiced/card.rb
 - lib/invoiced/catalog_item.rb
+- lib/invoiced/charge.rb
 - lib/invoiced/contact.rb
 - lib/invoiced/coupon.rb
 - lib/invoiced/credit_note.rb
@@ -80,10 +81,12 @@ files:
 - lib/invoiced/operations/delete.rb
 - lib/invoiced/operations/list.rb
 - lib/invoiced/operations/update.rb
+- lib/invoiced/payment.rb
 - lib/invoiced/payment_plan.rb
 - lib/invoiced/payment_source.rb
 - lib/invoiced/payment_source_object.rb
 - lib/invoiced/plan.rb
+- lib/invoiced/refund.rb
 - lib/invoiced/subscription.rb
 - lib/invoiced/task.rb
 - lib/invoiced/tax_rate.rb
@@ -92,6 +95,7 @@ files:
 - lib/invoiced/util.rb
 - lib/invoiced/version.rb
 - test/invoiced/catalog_item_test.rb
+- test/invoiced/charge_test.rb
 - test/invoiced/contact_test.rb
 - test/invoiced/coupon_test.rb
 - test/invoiced/credit_note_test.rb
@@ -107,7 +111,9 @@ files:
 - test/invoiced/object_test.rb
 - test/invoiced/payment_plan_test.rb
 - test/invoiced/payment_source_test.rb
+- test/invoiced/payment_test.rb
 - test/invoiced/plan_test.rb
+- test/invoiced/refund_test.rb
 - test/invoiced/subscription_test.rb
 - test/invoiced/task_test.rb
 - test/invoiced/tax_rate_test.rb
@@ -133,12 +139,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the Invoiced API
 test_files:
 - test/invoiced/catalog_item_test.rb
+- test/invoiced/charge_test.rb
 - test/invoiced/contact_test.rb
 - test/invoiced/coupon_test.rb
 - test/invoiced/credit_note_test.rb
@@ -154,7 +161,9 @@ test_files:
 - test/invoiced/object_test.rb
 - test/invoiced/payment_plan_test.rb
 - test/invoiced/payment_source_test.rb
+- test/invoiced/payment_test.rb
 - test/invoiced/plan_test.rb
+- test/invoiced/refund_test.rb
 - test/invoiced/subscription_test.rb
 - test/invoiced/task_test.rb
 - test/invoiced/tax_rate_test.rb