octobat 2.0.17 → 2.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cba02a0cbd6ef4f0f6f8687a7addcd59dd96a294
-  data.tar.gz: b519371775c52b8b6f6a8b30b11fabc9729f0cc1
+  metadata.gz: 346d7f40d07e9514915f5752d92de705bd6d3875
+  data.tar.gz: c0e09511acf91497cbe1d3dac2e30073e5480cce
 SHA512:
-  metadata.gz: 06fb388b483d8fe843c6db383abfdea030775ddc4603e02862692a1a81b8d7b478fd79d69a4c422b64bc00a8ad3ff41bd96b21b3304638a806b1de69349f9bc9
-  data.tar.gz: 732c2061e95830f5a0b94ca642102f1c4d95cdaa68a80c9009030e2506d0dc6500bbd867ef45a6c0b4cd316e0d48d1a90bd9c152740bdcbeb605644c7f313196
+  metadata.gz: 9ad71a3790764557809ccc97b339d1492efd6ee5524e24bb88ee63e478a09db741ce70e9eaa1fb4918e33df6f78b06cfc51b3b446a0fe8e1b59ff9cdc55feaae
+  data.tar.gz: 533fde0cda76b7581715078d0d6c8eefb3a0aa9cbeaa0b35ffb209bd1370b3e87a969c62c4edbff3a27f24f3ed7d0d062d1ecf2623970ca46329fb2457a2aa60

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    octobat (2.0.17)
+    octobat (2.0.18)
       rest-client (>= 1.4, < 4.0)
 
 GEM

data/History.txt

@@ -1,3 +1,9 @@
+=== 2.0.18 2020-05-25
+* 3 major enhancements:
+  * Add support for multipart encoder (file upload)
+  * Add support for File API endpoints
+  * Add support for Reporting API endpoints
+
 === 2.0.17 2020-04-27
 * 1 minor enhancement:
   * Update Order API endpoints

data/VERSION

@@ -1 +1 @@
-2.0.17
+2.0.18

data/lib/octobat.rb

@@ -17,6 +17,7 @@ require 'octobat/api_operations/delete'
 require 'octobat/api_operations/list'
 
 # Resources
+require 'octobat/multipart_encoder'
 require 'octobat/util'
 require 'octobat/octobat_object'
 require 'octobat/api_resource'
@@ -51,6 +52,12 @@ require 'octobat/exports_setting'
 require 'octobat/emails_setting'
 require 'octobat/tax_id'
 
+require 'octobat/file_upload'
+require 'octobat/file_link'
+require 'octobat/reporting/report_type'
+require 'octobat/reporting/report_run'
+
+
 # Errors
 require 'octobat/errors/octobat_error'
 require 'octobat/errors/octobat_lib_error'
@@ -63,6 +70,7 @@ module Octobat
   #DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
   @api_base = 'https://apiv2.octobat.com'
   #@api_base = 'http://api.octobat.local:3052'
+  @uploads_base = "https://files.octobat.com"
 
   @max_network_retries = 0
   @max_network_retry_delay = 2
@@ -75,7 +83,7 @@ module Octobat
 
 
   class << self
-    attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version
+    attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version, :uploads_base
     attr_reader :max_network_retry_delay, :initial_network_retry_delay
   end
 

data/lib/octobat/file_link.rb

@@ -0,0 +1,41 @@
+module Octobat
+  class FileLink < APIResource
+    include Octobat::APIOperations::Create
+    extend Octobat::APIOperations::List
+        
+    def self.create(params = {}, opts = {})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Octobat.request(:post, self.url, api_key, params, headers, Octobat.uploads_base)
+      Util.convert_to_octobat_object(response, api_key)
+    end
+    
+    def refresh
+      response, api_key = Octobat.request(:get, url, @api_key, @retrieve_options, @headers, Octobat.uploads_base)
+      refresh_from(response, api_key)
+    end
+    
+    def self.list(filters={}, opts={})
+      set_parent_resource(filters)
+      api_key, headers = Util.parse_opts(opts)
+      
+      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, Octobat.uploads_base)
+      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
+    
+    self.singleton_class.send(:alias_method, :all, :list)
+    
+  end
+end

data/lib/octobat/file_upload.rb

@@ -0,0 +1,59 @@
+module Octobat
+  class FileUpload < APIResource
+    include Octobat::APIOperations::Create
+    extend Octobat::APIOperations::List
+    
+    def self.url
+      "/files"
+    end
+    
+    
+    def self.create(params = {}, opts = {})
+      if params[:attachment] && !params[:attachment].is_a?(String)
+        unless params[:attachment].respond_to?(:read)
+          raise ArgumentError, "attachment must respond to `#read`"
+        end
+      end
+      
+      api_key, headers = Util.parse_opts(opts)
+      headers = headers.merge(content_type: MultipartEncoder::MULTIPART_FORM_DATA)
+      
+      response, api_key = Octobat.request(:post, self.url, api_key, params, headers, Octobat.uploads_base)
+      Util.convert_to_octobat_object(response, api_key)
+      
+    end
+        
+    def refresh
+      response, api_key = Octobat.request(:get, url, @api_key, @retrieve_options, @headers, Octobat.uploads_base)
+      refresh_from(response, api_key)
+    end
+    
+    
+    def self.list(filters={}, opts={})
+      set_parent_resource(filters)
+      api_key, headers = Util.parse_opts(opts)
+      
+      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, Octobat.uploads_base)
+      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
+    
+    self.singleton_class.send(:alias_method, :all, :list)
+
+    
+    
+    
+  end
+end

data/lib/octobat/multipart_encoder.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "tempfile"
+
+module Octobat
+  # Encodes parameters into a `multipart/form-data` payload as described by RFC
+  # 2388:
+  #
+  #     https://tools.ietf.org/html/rfc2388
+  #
+  # This is most useful for transferring file-like objects.
+  #
+  # Parameters should be added with `#encode`. When ready, use `#body` to get
+  # the encoded result and `#content_type` to get the value that should be
+  # placed in the `Content-Type` header of a subsequent request (which includes
+  # a boundary value).
+  class MultipartEncoder
+    MULTIPART_FORM_DATA = "multipart/form-data"
+
+    # A shortcut for encoding a single set of parameters and finalizing a
+    # result.
+    #
+    # Returns an encoded body and the value that should be set in the content
+    # type header of a subsequent request.
+    def self.encode(params)
+      encoder = MultipartEncoder.new
+      encoder.encode(params)
+      encoder.close
+      [encoder.body, encoder.content_type]
+    end
+
+    # Gets the object's randomly generated boundary string.
+    attr_reader :boundary
+
+    # Initializes a new multipart encoder.
+    def initialize
+      # Kind of weird, but required by Rubocop because the unary plus operator
+      # is considered faster than `Octobat.new`.
+      @body = +""
+
+      # Chose the same number of random bytes that Go uses in its standard
+      # library implementation. Easily enough entropy to ensure that it won't
+      # be present in a file we're sending.
+      @boundary = SecureRandom.hex(30)
+
+      @closed = false
+      @first_field = true
+    end
+
+    # Gets the encoded body. `#close` must be called first.
+    def body
+      raise "object must be closed before getting body" unless @closed
+
+      @body
+    end
+
+    # Finalizes the object by writing the final boundary.
+    def close
+      raise "object already closed" if @closed
+
+      @body << "\r\n"
+      @body << "--#{@boundary}--"
+
+      @closed = true
+
+      nil
+    end
+
+    # Gets the value including boundary that should be put into a multipart
+    # request's `Content-Type`.
+    def content_type
+      "#{MULTIPART_FORM_DATA}; boundary=#{@boundary}"
+    end
+
+    # Encodes a set of parameters to the body.
+    #
+    # Note that parameters are expected to be a hash, but a "flat" hash such
+    # that complex substructures like hashes and arrays have already been
+    # appropriately Octobat-encoded. Pass a complex structure through
+    # `Util.flatten_params` first before handing it off to this method.
+    def encode(params)
+      raise "no more parameters can be written to closed object" if @closed
+
+      params.each do |name, val|
+        if val.is_a?(::File) || val.is_a?(::Tempfile)
+          write_field(name, val.read, filename: ::File.basename(val.path))
+        elsif val.respond_to?(:read)
+          write_field(name, val.read, filename: "blob")
+        else
+          write_field(name, val, filename: nil)
+        end
+      end
+
+      nil
+    end
+
+    #
+    # private
+    #
+
+    # Escapes double quotes so that the given value can be used in a
+    # double-quoted string and replaces any linebreak characters with spaces.
+    private def escape(str)
+      str.gsub('"', "%22").tr("\n", " ").tr("\r", " ")
+    end
+
+    private def write_field(name, data, filename:)
+      if !@first_field
+        @body << "\r\n"
+      else
+        @first_field = false
+      end
+
+      @body << "--#{@boundary}\r\n"
+
+      if filename
+        @body << %(Content-Disposition: form-data) +
+                 %(; name="#{escape(name.to_s)}") +
+                 %(; filename="#{escape(filename)}"\r\n)
+        @body << %(Content-Type: application/octet-stream\r\n)
+      else
+        @body << %(Content-Disposition: form-data) +
+                 %(; name="#{escape(name.to_s)}"\r\n)
+      end
+
+      @body << "\r\n"
+      @body << data.to_s
+    end
+  end
+end

data/lib/octobat/reporting/report_run.rb

@@ -0,0 +1,12 @@
+module Octobat
+  module Reporting
+    class ReportRun < APIResource
+      include Octobat::APIOperations::Create
+      extend Octobat::APIOperations::List
+      
+      def self.url
+        '/reporting/report_runs'
+      end
+    end
+  end
+end

data/lib/octobat/reporting/report_type.rb

@@ -0,0 +1,12 @@
+module Octobat
+  module Reporting
+    class ReportType < APIResource
+      extend Octobat::APIOperations::List
+      
+      def self.url
+        '/reporting/report_types'
+      end
+      
+    end
+  end
+end

data/lib/octobat/util.rb

@@ -65,7 +65,11 @@ module Octobat
         'document_email_template' => DocumentEmailTemplate,
         'exports_setting' => ExportsSetting,
         'document' => Document,
-        'emails_setting' => EmailsSetting
+        'emails_setting' => EmailsSetting,
+        'file' => FileUpload,
+        'file_link' => FileLink,
+        'reporting.report_type' => Reporting::ReportType,
+        'reporting.report_run' => Reporting::ReportRun
       }
     end
 

data/lib/octobat/version.rb

@@ -1,3 +1,3 @@
 module Octobat
-  VERSION = '2.0.17'
+  VERSION = '2.0.18'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octobat
 version: !ruby/object:Gem::Version
-  version: 2.0.17
+  version: 2.0.18
 platform: ruby
 authors:
 - Gaultier Laperche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -79,10 +79,13 @@ files:
 - lib/octobat/errors/octobat_error.rb
 - lib/octobat/errors/octobat_lib_error.rb
 - lib/octobat/exports_setting.rb
+- lib/octobat/file_link.rb
+- lib/octobat/file_upload.rb
 - lib/octobat/invoice.rb
 - lib/octobat/invoice_numbering_sequence.rb
 - lib/octobat/item.rb
 - lib/octobat/list_object.rb
+- lib/octobat/multipart_encoder.rb
 - lib/octobat/octobat_object.rb
 - lib/octobat/order.rb
 - lib/octobat/payment_recipient.rb
@@ -91,6 +94,8 @@ files:
 - lib/octobat/payout.rb
 - lib/octobat/product.rb
 - lib/octobat/proforma_invoice.rb
+- lib/octobat/reporting/report_run.rb
+- lib/octobat/reporting/report_type.rb
 - lib/octobat/singleton_api_resource.rb
 - lib/octobat/tax_evidence.rb
 - lib/octobat/tax_evidence_request.rb