octobat 0.0.12 → 2.0.0

data/lib/octobat/list_object.rb

@@ -3,12 +3,13 @@ module Octobat
     include Enumerable
     include Octobat::APIOperations::List
     
-    attr_accessor :filters, :cursors
+    attr_accessor :filters, :cursors, :parent_resource
     
     def initialize(*args)
       super
       self.filters = {}
       self.cursors = {}
+      self.parent_resource = {}
     end
 
     def [](k)
@@ -28,10 +29,12 @@ module Octobat
       self.data.empty?
     end
 
-    def retrieve(id, api_key=nil)
+    def retrieve(id, opts={})
+      api_key, headers = Util.parse_opts(opts)
       api_key ||= @api_key
+      
       response, api_key = Octobat.request(:get, "#{url}/#{CGI.escape(id)}", api_key)
-      Util.convert_to_octobat_object(response, api_key)
+      Util.convert_to_octobat_object(response, api_key, self.parent_resource)
     end
 
     def create(params={}, opts={})
@@ -45,7 +48,7 @@ module Octobat
     def next_page_params(params={}, opts={})
       return nil if !has_more
       last_id = data.last.id
-
+      
       params = filters.merge({
         starting_after: last_id
       }).merge(params)
@@ -61,5 +64,10 @@ module Octobat
       }).merge(params)
     end
     
+    
+    def url
+      self.request_url
+    end
+    
   end
 end

data/lib/octobat/octobat_object.rb

@@ -2,7 +2,7 @@ module Octobat
   class OctobatObject
     include Enumerable
 
-    attr_accessor :api_key
+    attr_accessor :api_key, :parent_obj
     @@permanent_attributes = Set.new([:api_key, :id])
 
     # The default :id method is deprecated and isn't useful to us
@@ -10,7 +10,7 @@ module Octobat
       undef :id
     end
 
-    def initialize(id=nil, api_key=nil)
+    def initialize(id=nil, opts={})
       # parameter overloading!
       if id.kind_of?(Hash)
         @retrieve_options = id.dup
@@ -20,7 +20,10 @@ module Octobat
         @retrieve_options = {}
       end
 
-      @api_key = api_key
+      @api_key = opts[:api_key]
+      
+      @retrieve_options.merge!(opts.clone).delete(:api_key)
+      
       @values = {}
       # This really belongs in APIResource, but not putting it there allows us
       # to have a unified inspect method
@@ -30,7 +33,7 @@ module Octobat
     end
 
     def self.construct_from(values, api_key=nil)
-      self.new(values[:id], api_key).refresh_from(values, api_key)
+      self.new(values[:id], api_key: api_key).refresh_from(values, api_key)
     end
 
     def to_s(*args)
@@ -63,6 +66,12 @@ module Octobat
       end
       values.each do |k, v|
         @values[k] = Util.convert_to_octobat_object(v, api_key)
+        
+        case @values[k]
+        when ListObject
+          @values[k].parent_resource = {self.object.to_sym => self.id}
+        end
+        
         @transient_values.delete(k)
         @unsaved_values.delete(k)
       end

data/lib/octobat/payment_recipient.rb

@@ -0,0 +1,7 @@
+module Octobat
+  class PaymentRecipient < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+  end
+end

data/lib/octobat/{numbering_sequence.rb → payment_recipient_reference.rb}

@@ -1,5 +1,5 @@
 module Octobat
-  class NumberingSequence < APIResource
+  class PaymentRecipientReference < APIResource
     extend Octobat::APIOperations::List
   end
 end

data/lib/octobat/payment_source.rb

@@ -0,0 +1,16 @@
+module Octobat
+  class PaymentSource < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+
+    def self.url
+      if @parent_resource.include?(:customer)
+        "#{Customer.url}/#{CGI.escape(@parent_resource[:customer])}/payment_sources"
+      end
+    end
+
+    def self.parent_resource(filters)
+      @parent_resource = filters.select{|k, v| [:customer].include?(k)}
+    end
+  end
+end

data/lib/octobat/{invoice_item.rb → tax_evidence.rb}

@@ -1,5 +1,5 @@
 module Octobat
-  class InvoiceItem < APIResource
+  class TaxEvidence < APIResource
     include Octobat::APIOperations::Create
   end
 end

data/lib/octobat/tax_evidence_request.rb

@@ -0,0 +1,5 @@
+module Octobat
+  class TaxEvidenceRequest < APIResource
+    include Octobat::APIOperations::Create
+  end
+end

data/lib/octobat/tax_region_setting.rb

@@ -0,0 +1,27 @@
+module Octobat
+  class TaxRegionSetting < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Update
+    include Octobat::APIOperations::Create
+
+    def activate
+      response, api_key = Octobat.request(:patch, activate_url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    def unactivate
+      response, api_key = Octobat.request(:patch, unactivate_url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    private
+
+      def activate_url
+        url + '/activate'
+      end
+
+      def unactivate_url
+        url + '/unactivate'
+      end
+  end
+end

data/lib/octobat/transaction.rb

@@ -0,0 +1,11 @@
+module Octobat
+  class Transaction < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def items(params = {})
+      Item.list(params.merge({ :transaction => id }), @api_key)
+    end
+  end
+end

data/lib/octobat/util.rb

@@ -17,7 +17,7 @@ module Octobat
         h
       end
     end
-    
+
     def self.objects_to_ids(h)
       case h
       when APIResource
@@ -39,23 +39,39 @@ module Octobat
         'list' => ListObject,
 
         # business objects
-        'payment_mode' => PaymentMode,
-        'payment' => Payment,
-        'numbering_sequence' => NumberingSequence,
+        'payment_recipient' => PaymentRecipient,
+        'payment_recipient_reference' => PaymentRecipientReference,
+        'payment_source' => PaymentSource,
+        'invoice_numbering_sequence' => InvoiceNumberingSequence,
         'credit_note_numbering_sequence' => CreditNoteNumberingSequence,
         'invoice' => Invoice,
-        'invoice_item' => InvoiceItem,
-        'customer' => Customer
+        'credit_note' => CreditNote,
+        'item' => Item,
+        'customer' => Customer,
+        'document_template' => DocumentTemplate,
+        'document_language' => DocumentLanguage,
+        'checkout' => Checkout,
+        'coupon' => Coupon,
+        'tax_region_setting' => TaxRegionSetting,
+        'transaction' => Transaction,
+        'tax_evidence' => TaxEvidence,
+        'tax_evidence_request' => TaxEvidenceRequest,
+        'document_email_template' => DocumentEmailTemplate,
+        'exports_setting' => ExportsSetting,
+        'document' => Document,
+        'emails_setting' => EmailsSetting
       }
     end
 
-    def self.convert_to_octobat_object(resp, api_key)
+    def self.convert_to_octobat_object(resp, api_key, parent_resource = nil)
       case resp
       when Array
-        resp.map { |i| convert_to_octobat_object(i, api_key) }
+        resp.map { |i| convert_to_octobat_object(i, api_key, parent_resource) }
       when Hash
         # Try converting to a known object class.  If none available, fall back to generic OctobatObject
-        object_classes.fetch(resp[:object], OctobatObject).construct_from(resp, api_key)
+        obj = object_classes.fetch(resp[:object], OctobatObject).construct_from(resp, api_key)
+        obj.parent_obj = parent_resource if parent_resource && obj.respond_to?(:parent_obj)
+        obj
       else
         resp
       end
@@ -132,7 +148,9 @@ module Octobat
       when String
         return opts, {}
       when Hash
-        headers = {}
+        headers = opts.clone
+        headers.delete(:api_key)
+
         if opts[:idempotency_key]
           headers[:idempotency_key] = opts[:idempotency_key]
         end

data/lib/octobat/version.rb

@@ -1,3 +1,3 @@
 module Octobat
-  VERSION = '0.0.12'
+  VERSION = '2.0.0'
 end

data/octobat.gemspec

@@ -12,9 +12,9 @@ spec = Gem::Specification.new do |s|
   s.homepage = 'https://www.octobat.com/api'
   s.license = 'MIT'
 
-  s.add_dependency('rest-client', '~> 1.4')
-  s.add_dependency('mime-types', '>= 1.25', '< 3.0')
-  s.add_dependency('json', '~> 1.8.1')
+  s.add_dependency('rest-client', '>= 1.4', '< 4.0')
+  #s.add_dependency('mime-types', '>= 1.25', '< 3.0')
+  #s.add_dependency('json', '~> 1.8.1')
 
   #s.add_development_dependency('mocha', '~> 0.13.2')
   #s.add_development_dependency('shoulda', '~> 3.4.0')

metadata

@@ -1,63 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: octobat
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 2.0.0
 platform: ruby
 authors:
 - Gaultier Laperche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.25'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.25'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '1.4'
+    - - <
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '4.0'
 description: Octobat is the easiest way to generate invoices online. See https://www.octobat.com
   for details.
 email:
@@ -67,8 +39,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CONTRIBUTORS
 - Gemfile
 - Gemfile.lock
@@ -89,21 +61,37 @@ files:
 - lib/octobat/api_operations/update.rb
 - lib/octobat/api_resource.rb
 - lib/octobat/certificate_blacklist.rb
+- lib/octobat/checkout.rb
+- lib/octobat/coupon.rb
+- lib/octobat/credit_note.rb
 - lib/octobat/credit_note_numbering_sequence.rb
 - lib/octobat/customer.rb
+- lib/octobat/document.rb
+- lib/octobat/document_email_template.rb
+- lib/octobat/document_language.rb
+- lib/octobat/document_template.rb
+- lib/octobat/emails_setting.rb
 - lib/octobat/errors/api_connection_error.rb
 - lib/octobat/errors/api_error.rb
 - lib/octobat/errors/authentication_error.rb
 - lib/octobat/errors/invalid_request_error.rb
 - lib/octobat/errors/octobat_error.rb
+- lib/octobat/errors/octobat_lib_error.rb
+- lib/octobat/exports_setting.rb
 - lib/octobat/invoice.rb
-- lib/octobat/invoice_item.rb
+- lib/octobat/invoice_numbering_sequence.rb
+- lib/octobat/item.rb
 - lib/octobat/list_object.rb
-- lib/octobat/numbering_sequence.rb
 - lib/octobat/octobat_object.rb
 - lib/octobat/payment.rb
-- lib/octobat/payment_mode.rb
+- lib/octobat/payment_recipient.rb
+- lib/octobat/payment_recipient_reference.rb
+- lib/octobat/payment_source.rb
 - lib/octobat/singleton_api_resource.rb
+- lib/octobat/tax_evidence.rb
+- lib/octobat/tax_evidence_request.rb
+- lib/octobat/tax_region_setting.rb
+- lib/octobat/transaction.rb
 - lib/octobat/util.rb
 - lib/octobat/version.rb
 - octobat.gemspec
@@ -117,17 +105,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Octobat API