octobat 0.0.12 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c003fafc9cbcbe437c10d026bb43bf56a0d77c19
-  data.tar.gz: df2387863f7ca20cc57d24cefd884134df02b877
+  metadata.gz: 041400ae286b51b2e0aaabcc19780b1b7e422640
+  data.tar.gz: 3db20d4d584da54c530ece341ce3451b11ef5bcf
 SHA512:
-  metadata.gz: 417b0c965a6548d82da50b820d0809bf239f1c41a5be8c2f7171cf64f2d44c1e2b9d820c49bbe07c3b2d47641e9cc9ace6599572e952961665c4a6ae014ee559
-  data.tar.gz: 7118109f8be2cf85cbff460a081bb0ac4cb36606a7231779b2715337ad20dcba83fe65e6ad96abe3f38229ce0936f8b5ad886072f7cf357572564bcec141791a
+  metadata.gz: 4cf9162c36bfa08b72dc53e069053a9d88513e438ffec9f49d42855a0b7259e756afdd808682e0c9c32844302777f6a9bfe54bd99f9237049b069d356143ceeb
+  data.tar.gz: 3b4792604be22a61edaa987e98da891801ca187ec8ecc241da9d15bb0dfc09df734525b972d6cc253a2ed2c1df726d1d5d153d74012155b59aee55aacce8dced

data/.gitignore

@@ -1,2 +1,3 @@
 /octobat-*.gem
 .rvmrc
+.ruby-version

data/Gemfile

@@ -1,8 +1,9 @@
 source "https://rubygems.org"
 gemspec
 
-if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9.3')
+if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0')
   gem 'i18n', '< 0.7'
   gem 'rest-client', '~> 1.6.8'
+  gem 'mime-types', '< 3.0'
   gem 'activesupport', '~> 3.2'
 end

data/Gemfile.lock

@@ -1,23 +1,33 @@
 PATH
   remote: .
   specs:
-    octobat (0.0.12)
-      json (~> 1.8.1)
-      mime-types (>= 1.25, < 3.0)
-      rest-client (~> 1.4)
+    octobat (2.0.0)
+      rest-client (>= 1.4, < 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    json (1.8.3)
-    mime-types (2.99.1)
-    netrc (0.10.2)
-    rest-client (1.7.2)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
+    domain_name (0.5.20161129)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    rest-client (2.0.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   octobat!
+
+BUNDLED WITH
+   1.13.7

data/History.txt

@@ -1,3 +1,36 @@
+=== 2.0.0 2017-01-23
+* 1 major enhancement:
+  * Bump to Octobat v2 API endpoint
+  
+=== 0.0.12 2016-04-13
+* 1 minor enhancement:
+  * Add pagination helpers
+
+=== 0.0.9 2016-04-13
+* 1 major enhancement
+  * Can initialize Octobat Objects without persistence, and save them later with save method
+
+=== 0.0.8 2016-02-04
+* 3 minor enhancements:
+  * Add the draft invoices feature, refactoring invoices#create to create only draft invoices
+  * Add invoices#confirm to confirm draft invoices and insert them into the numbering sequence
+  * Add invoice_items#create for creating invoice items
+
+=== 0.0.6 2015-10-13
+* 2 minor enhancements:
+  * Add invoices#update for non already-sent invoices
+  * Add invoices#send to make the email sending programmable
+
+=== 0.0.5 2015-07-21
+* 1 minor enhancement:
+  * Add invoices#all customer filter and Customer.invoices method
+  
+=== 0.0.1 2015-02-06
+
+* 1 major enhancement:
+  * Initial release
+
+
 === 0.0.12 2016-04-13
 * 1 minor enhancement:
   * Add pagination helpers

data/VERSION

@@ -1 +1 @@
-0.0.12
+2.0.0

data/lib/octobat.rb

@@ -23,16 +23,32 @@ require 'octobat/api_resource'
 require 'octobat/singleton_api_resource'
 require 'octobat/list_object'
 
-require 'octobat/numbering_sequence'
-require 'octobat/payment_mode'
-require 'octobat/payment'
-require 'octobat/credit_note_numbering_sequence'
 require 'octobat/customer'
+require 'octobat/transaction'
+require 'octobat/item'
+require 'octobat/document'
 require 'octobat/invoice'
-require 'octobat/invoice_item'
+require 'octobat/credit_note'
+require 'octobat/payment_recipient'
+require 'octobat/payment_recipient_reference'
+require 'octobat/payment_source'
+require 'octobat/invoice_numbering_sequence'
+require 'octobat/credit_note_numbering_sequence'
+require 'octobat/document_template'
+require 'octobat/document_language'
+require 'octobat/checkout'
+require 'octobat/coupon'
+require 'octobat/tax_region_setting'
+require 'octobat/tax_evidence'
+require 'octobat/tax_evidence_request'
+require 'octobat/document_email_template'
+require 'octobat/exports_setting'
+require 'octobat/emails_setting'
+
 
 # Errors
 require 'octobat/errors/octobat_error'
+require 'octobat/errors/octobat_lib_error'
 require 'octobat/errors/api_error'
 require 'octobat/errors/api_connection_error'
 require 'octobat/errors/invalid_request_error'
@@ -40,8 +56,13 @@ require 'octobat/errors/authentication_error'
 
 module Octobat
   #DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
-  @api_base = 'https://api.octobat.com'
-  #@api_base = 'http://api.octobat.local:3040'
+  @api_base = 'https://apiv2.octobat.com'
+  #@api_base = 'http://api.octobat.local:3052'
+
+  @max_network_retries = 0
+  @max_network_retry_delay = 2
+  @initial_network_retry_delay = 0.5
+
 
   #@ssl_bundle_path  = DEFAULT_CA_BUNDLE_PATH
   #@verify_ssl_certs = true
@@ -50,6 +71,7 @@ module Octobat
 
   class << self
     attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version
+    attr_reader :max_network_retry_delay, :initial_network_retry_delay
   end
 
   def self.api_url(url='', api_base_url=nil)
@@ -98,19 +120,33 @@ module Octobat
       end
     end
 
-    request_opts.update(:headers => request_headers(api_key).update(headers),
+    request_opts.update(:headers => request_headers(api_key, method).update(headers),
                         :method => method, :open_timeout => 30,
                         :payload => payload, :url => url, :timeout => 80)
 
+    response = execute_request_with_rescues(request_opts, api_base_url)
+    [parse(response), api_key]
+  end
+
+  def self.max_network_retries
+    @max_network_retries
+  end
+
+  def self.max_network_retries=(val)
+    @max_network_retries = val.to_i
+  end
+
+
+  def self.execute_request_with_rescues(request_opts, api_base_url, retry_count = 0)
     begin
       response = execute_request(request_opts)
     rescue SocketError => e
-      handle_restclient_error(e, api_base_url)
+      response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
     rescue NoMethodError => e
       # Work around RestClient bug
       if e.message =~ /\WRequestFailed\W/
         e = APIConnectionError.new('Unexpected HTTP response code')
-        handle_restclient_error(e, api_base_url)
+        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
       else
         raise
       end
@@ -118,13 +154,13 @@ module Octobat
       if rcode = e.http_code and rbody = e.http_body
         handle_api_error(rcode, rbody)
       else
-        handle_restclient_error(e, api_base_url)
+        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
       end
     rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      handle_restclient_error(e, api_base_url)
+      response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
     end
 
-    [parse(response), api_key]
+    response
   end
 
   private
@@ -174,13 +210,17 @@ module Octobat
       map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
   end
 
-  def self.request_headers(api_key)
+  def self.request_headers(api_key, method)
     headers = {
       :user_agent => "Octobat/v1 RubyBindings/#{Octobat::VERSION}",
       :authorization => 'Basic ' + Base64.encode64( "#{api_key}:" ).chomp,
       :content_type => 'application/x-www-form-urlencoded'
     }
 
+    if [:post, :delete, :patch].include?(method) && self.max_network_retries > 0
+      headers[:idempotency_key] ||= SecureRandom.uuid
+    end
+
     headers[:octobat_version] = api_version if api_version
 
     begin
@@ -216,14 +256,14 @@ module Octobat
     begin
       error_obj = JSON.parse(rbody)
       error_obj = Util.symbolize_names(error_obj)
-      error = error_obj[:error] or raise OctobatError.new # escape from parsing
+      error = error_obj[:errors] or raise OctobatError.new # escape from parsing
 
     rescue JSON::ParserError, OctobatError
       raise general_api_error(rcode, rbody)
     end
 
     case rcode
-    when 400, 404
+    when 400, 402, 404, 422
       raise invalid_request_error error, rcode, rbody, error_obj
     when 401
       raise authentication_error error, rcode, rbody, error_obj
@@ -234,8 +274,7 @@ module Octobat
   end
 
   def self.invalid_request_error(error, rcode, rbody, error_obj)
-    InvalidRequestError.new(error[:message], error[:param], rcode,
-                            rbody, error_obj)
+    InvalidRequestError.new(error, rcode, rbody, error_obj)
   end
 
   def self.authentication_error(error, rcode, rbody, error_obj)
@@ -251,7 +290,16 @@ module Octobat
     APIError.new(error[:message], rcode, rbody, error_obj)
   end
 
-  def self.handle_restclient_error(e, api_base_url=nil)
+  def self.handle_restclient_error(e, request_opts, retry_count, api_base_url=nil)
+
+    if should_retry?(e, retry_count)
+      retry_count = retry_count + 1
+      sleep sleep_time(retry_count)
+      response = execute_request_with_rescues(request_opts, api_base_url, retry_count)
+      return response
+    end
+
+
     api_base_url = @api_base unless api_base_url
     connection_message = "Please check your internet connection and try again. " \
         "If this problem persists, you should check Octobat's service status at " \
@@ -282,6 +330,34 @@ module Octobat
 
     end
 
+    if retry_count > 0
+      message += " Request was retried #{retry_count} times."
+    end
+
     raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
   end
+
+
+  def self.should_retry?(e, retry_count)
+    puts "Retry count: #{retry_count}"
+    return false if retry_count >= self.max_network_retries
+    #return false if e.is_a?(RestClient::SSLCertificateNotVerified)
+    return true
+  end
+
+  def self.sleep_time(retry_count)
+    # This method was adapted from https://github.com/ooyala/retries/blob/master/lib/retries.rb
+
+    # The sleep time is an exponentially-increasing function of base_sleep_seconds. But, it never exceeds
+    # max_sleep_seconds.
+    sleep_seconds = [initial_network_retry_delay * (2 ** (retry_count - 1)), max_network_retry_delay].min
+    # Randomize to a random value in the range sleep_seconds/2 .. sleep_seconds
+
+    sleep_seconds = sleep_seconds * (0.5 * (1 + rand()))
+    # But never sleep less than base_sleep_seconds
+    sleep_seconds = [initial_network_retry_delay, sleep_seconds].max
+
+    sleep_seconds
+  end
+
 end

data/lib/octobat/api_operations/delete.rb

@@ -3,6 +3,7 @@ module Octobat
     module Delete
       def delete(params = {}, opts={})
         api_key, headers = Util.parse_opts(opts)
+        
         response, api_key = Octobat.request(:delete, url, api_key || @api_key, params, headers)
         refresh_from(response, api_key)
       end

data/lib/octobat/api_operations/list.rb

@@ -2,23 +2,30 @@ module Octobat
   module APIOperations
     module List
       def list(filters={}, opts={})
+        set_parent_resource(filters)
         api_key, headers = Util.parse_opts(opts)
-        api_key ||= @api_key
-        
-        #opts = Util.normalize_opts(opts)
-        #opts = @opts.merge(opts) if @opts
         
-        response, api_key = Octobat.request(:get, url, api_key, filters, headers)
+        api_key ||= @api_key
+
+        f = filters.select{|request_filter| !@parent_resource.has_key?(request_filter)}
+
+        response, api_key = Octobat.request(:get, url, api_key, f, headers)
         obj = ListObject.construct_from(response, api_key)
-        
+
         obj.filters = filters.dup
         obj.cursors[:ending_before] = obj.filters.delete(:ending_before)
         obj.cursors[:starting_after] = obj.filters.delete(:starting_after)
-        
-        
+
+        obj.filters.delete(:expand)
+        obj.parent_resource = @parent_resource
+
         obj
       end
-      
+
+      def set_parent_resource(filters)
+        @parent_resource = {}
+      end
+
       alias :all :list
     end
   end

data/lib/octobat/api_operations/update.rb

@@ -1,8 +1,11 @@
 module Octobat
   module APIOperations
     module Update
-      def save(opts={})
+      def save(opts={}, headers = {})
         values = serialize_params(self).merge(opts)
+        
+        api_key, headers = Util.parse_opts(headers)
+        api_key ||= @api_key
 
         if @values[:metadata]
           values[:metadata] = serialize_metadata
@@ -11,7 +14,7 @@ module Octobat
         if values.length > 0
           values.delete(:id)
 
-          response, api_key = Octobat.request(save_method, save_url, @api_key, values)
+          response, api_key = Octobat.request(save_method, save_url, api_key, values)
           refresh_from(response, api_key)
         end
         self
@@ -37,7 +40,7 @@ module Octobat
       def serialize_params(obj)
         case obj
         when nil
-          ''
+          self[:id].nil? ? nil : ''
         when OctobatObject
           unsaved_keys = obj.instance_variable_get(:@unsaved_values)
           obj_values = obj.instance_variable_get(:@values)
@@ -53,7 +56,7 @@ module Octobat
         end
       end
       
-      private
+      protected
         def save_url
           if self[:id] == nil && self.class.respond_to?(:create)
             self.class.url

data/lib/octobat/api_resource.rb

@@ -23,8 +23,11 @@ module Octobat
       refresh_from(response, api_key)
     end
 
-    def self.retrieve(id, api_key=nil)
-      instance = self.new(id, api_key)
+    def self.retrieve(id, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      opts[:api_key] ||= @api_key
+            
+      instance = self.new(id, opts)
       instance.refresh
       instance
     end

data/lib/octobat/{payment_mode.rb → checkout.rb}

@@ -1,5 +1,5 @@
 module Octobat
-  class PaymentMode < APIResource
+  class Checkout < APIResource
     extend Octobat::APIOperations::List
     include Octobat::APIOperations::Create
     include Octobat::APIOperations::Update

data/lib/octobat/coupon.rb

@@ -0,0 +1,32 @@
+module Octobat
+  class Coupon < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    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
+
+    def delete
+      response, api_key = Octobat.request(:delete, url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    private
+
+      def activate_url
+        url + '/activate'
+      end
+
+      def unactivate_url
+        url + '/unactivate'
+      end
+  end
+end