invoiced 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5997cf1ddd23e0cece25a26780c348354a672b9c
-  data.tar.gz: 7f0a09349c1b87b9cfb11c8afbdf6533a566cdd2
+  metadata.gz: af3c9c33d3ab2a41846eec239e659b6a83567f1e
+  data.tar.gz: c27763abfd2ac362595eb44c9ff4afd067485346
 SHA512:
-  metadata.gz: cf0aa2c91593969dfe034a8f6f5db01fe6e7ee7164c0327ddd67de29c968b2378311af6ccbae253d90f75be240491cda23fa8bb3d3b09bc351ef9ce2a27cabdf
-  data.tar.gz: 9c936769e5d820574fdfef68e508454c1aa0fba468a602bfc4bc1e49edba3dcad2a2d4f8ca27fe92d2f2a546d6a55a45ecf58783b1bcfcb8541cbb43cf95dca4
+  metadata.gz: df10f784d4468a435fab99638180f213c30325cc0f40a695809b306bf3ebad5846804eb5a47d1f9a865ddc77ececf0694f634c28ff6fea45b1d102425a8aed7e
+  data.tar.gz: 5a0e7161ac5632520f9cf7c39e4f91ab2a2d39f47a4e240c8144e314fc22dc8a81839864da14a2bcc8e3b8f28d1b48101fe3e959de35eeec79673d0e19c95267

data/.travis.yml

@@ -4,6 +4,8 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+  - 2.3
+  - 2.4
 
 sudo: false
 

data/Gemfile

@@ -1,9 +1,14 @@
 source "https://rubygems.org"
 gemspec
 
-gem 'json', '~> 1.8.3'
 gem 'rest-client', '~> 2.0.0'
-gem 'activesupport', '~> 4.2.3'
+gem 'jwt', '~> 2.0.0'
+
+gem 'mocha', '~> 0.13.2', :require => false, :group => :test
+gem 'shoulda', '~> 3.4.0', :require => false, :group => :test
+gem 'test-unit', :require => false, :group => :test
+gem 'rake', :require => false, :group => :test
+gem 'activesupport', '~> 4.2.9', :require => false, :group => :test
 gem 'coveralls', :require => false, :group => :test
 gem 'simplecov', '~> 0.10.0', :require => false, :group => :test
 gem 'simplecov-console', '~> 0.3.1', :require => false, :group => :test

data/README.md

@@ -25,7 +25,7 @@ gem 'invoiced'
 ## Requirements
 
 - Ruby 2.0+
-- rest_client, json, and active_support gems
+- rest_client gem
 
 ## Usage
 

data/invoiced.gemspec

@@ -15,13 +15,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
 
   s.add_dependency('rest-client', '~> 2.0.0')
-  s.add_dependency('json', '~> 1.8.3')
-  s.add_dependency('activesupport', '~> 4.2.3')
-
-  s.add_development_dependency('mocha', '~> 0.13.2')
-  s.add_development_dependency('shoulda', '~> 3.4.0')
-  s.add_development_dependency('test-unit')
-  s.add_development_dependency('rake')
+  s.add_dependency('jwt', '~> 2.0.0')
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

data/lib/invoiced/attachment.rb

@@ -1,4 +1,5 @@
 module Invoiced
     class Attachment < Object
+        OBJECT_NAME = 'attachment'
     end
 end

data/lib/invoiced/catalog_item.rb

@@ -4,5 +4,7 @@ module Invoiced
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'catalog_item'
     end
 end

data/lib/invoiced/contact.rb

@@ -4,5 +4,7 @@ module Invoiced
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'contact'
     end
 end

data/lib/invoiced/credit_note.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'credit_note'
+
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 

data/lib/invoiced/customer.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'customer'
+
         def send_statement(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 

data/lib/invoiced/email.rb

@@ -1,4 +1,5 @@
 module Invoiced
     class Email < Object
+        OBJECT_NAME = 'email'
     end
 end

data/lib/invoiced/estimate.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'estimate'
+
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 

data/lib/invoiced/event.rb

@@ -1,5 +1,7 @@
 module Invoiced
     class Event < Object
         include Invoiced::Operations::List
+
+        OBJECT_NAME = 'event'
     end
 end

data/lib/invoiced/file.rb

@@ -2,5 +2,7 @@ module Invoiced
     class File < Object
         include Invoiced::Operations::Create
         include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'file'
     end
 end

data/lib/invoiced/invoice.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'invoice'
+
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 

data/lib/invoiced/line_item.rb

@@ -4,5 +4,7 @@ module Invoiced
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'line_item'
     end
 end

data/lib/invoiced/object.rb

@@ -8,10 +8,8 @@ module Invoiced
 
         def initialize(client, id=nil, values={})
             @client = client
-            class_name = self.class.name.split('::').last
             @endpoint_base = ''
-            @endpoint = '/' + class_name.underscore.pluralize.downcase
-
+            @endpoint = build_endpoint
             @id = id
             @values = {}
 
@@ -35,6 +33,14 @@ module Invoiced
             @endpoint_base + @endpoint
         end
 
+        def build_endpoint
+            if self.class.const_defined? "OBJECT_NAME"
+                '/' + self.class::OBJECT_NAME + 's'
+            else
+                '/objects'
+            end
+        end
+
         def retrieve(id, params={})
             if !id
                 raise ArgumentError.new("Missing ID.")

data/lib/invoiced/payment_plan.rb

@@ -2,6 +2,8 @@ module Invoiced
     class PaymentPlan < Object
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'payment_plan'
+
         def initialize(client, id=nil, values={})
         	super
         	@endpoint = '/payment_plan'

data/lib/invoiced/plan.rb

@@ -4,5 +4,7 @@ module Invoiced
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'plan'
     end
 end

data/lib/invoiced/subscription.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'subscription'
+
         def cancel
             delete
         end

data/lib/invoiced/transaction.rb

@@ -5,6 +5,8 @@ module Invoiced
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
+        OBJECT_NAME = 'transaction'
+
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
 

data/lib/invoiced/version.rb

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

data/lib/invoiced.rb

@@ -1,7 +1,6 @@
 require 'rest-client'
 require 'json'
 require 'base64'
-require 'active_support/inflector'
 
 require 'invoiced/version'
 require 'invoiced/util'
@@ -42,13 +41,14 @@ module Invoiced
         OpenTimeout = 30
         ReadTimeout = 80
 
-        attr_reader :api_key, :api_url, :sandbox
+        attr_reader :api_key, :api_url, :sandbox, :sso_key
         attr_reader :CatalogItem, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Plan, :Subscription, :Transaction
 
-        def initialize(api_key, sandbox=false)
+        def initialize(api_key, sandbox=false, sso_key=false)
           @api_key = api_key
           @sandbox = sandbox
           @api_url = sandbox ? ApiBaseSandbox : ApiBase
+          @sso_key = sso_key
 
           # Object endpoints
           @CatalogItem = Invoiced::CatalogItem.new(self)
@@ -97,6 +97,23 @@ module Invoiced
             parse(response)
         end
 
+        def generate_sign_in_token(customerId, ttl)
+            if !@sso_key
+                raise "Please provide a single sign-on key! You can find this value in Settings > Developers > Single Sign-On of the Invoiced application."
+            end
+
+            expires = Time.now + ttl # TTL should be in seconds
+
+            payload = {
+                :sub => customerId,
+                :iss => "Invoiced Ruby/#{Invoiced::VERSION}",
+                :iat => Time.now.to_i,
+                :exp => expires.to_i
+            }
+
+            JWT.encode payload, @sso_key, 'HS256'
+        end
+
         private
 
         def buildHeaders(opts)

data/test/invoiced/invoiced_test.rb

@@ -2,6 +2,7 @@ require 'invoiced'
 require 'test/unit'
 require 'mocha/setup'
 require 'shoulda'
+require 'jwt'
 
 module Invoiced
   class InvoicedTest < Test::Unit::TestCase
@@ -261,5 +262,31 @@ module Invoiced
         client.request("POST", "/invoices")
       end
     end
+
+    should "generate a single sign-on token" do
+        ssoKey = '8baa4dbc338a54bbf7696eef3ee4aa2daadd61bba85fcfe8df96c7cfa227c43'
+        client = Invoiced::Client.new('API_KEY', false, ssoKey)
+        t = Time.now
+        
+        token = client.generate_sign_in_token(1234, 3600)
+        
+        decrypted = JWT.decode token, ssoKey, true, { :algorithm => 'HS256' }
+        assert_operator decrypted[0]['exp'] - t.to_i - 3600, :<, 3 # this accounts for slow running tests
+        decrypted[0].delete('exp')
+
+        expected = {
+            'iat' => t.to_i,
+            'sub' => 1234,
+            'iss' => 'Invoiced Ruby/'+Invoiced::VERSION
+        }
+        assert_equal(expected, decrypted[0])
+    end
+
+    should "raise an error when generating a single sign-on token with no key" do
+      client = Invoiced::Client.new('test')
+      assert_raise do
+        client.generate_sign_in_token(1234, 3600)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoiced
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Jared King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2017-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,89 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: json
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.3
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.2.3
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.3
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.2
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.0
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 description: Invoiced makes invoicing and recurring billing dead simple
 email: support@invoiced.com
 executables: []