fulfil-io 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 520488638d7340fb0278fc798770d821f87f0a7427765118c418f2db16877af1
-  data.tar.gz: 7c1dfb2aac58524eef56a7d38729ffd01f3350ff3413bd7e0b6fa8bf6ab37411
+  metadata.gz: 21d5119cc38db9e9a414775dcfc9b37d53ca5fa3ff05218c4ae81bbc912d0695
+  data.tar.gz: a4bf8e9ae17a2993c1a3644d298e39f71c78b1eddc40f6bb20d35bdb25ad1ba5
 SHA512:
-  metadata.gz: 035bc157721ab0b620cf30b99afdaf3825a2f8732e289a7b9e2b309bc99d25ec81cd3f1612ce88df4dcdb98a05a56fff295e8461f7a525e741e5d3200be8c9b6
-  data.tar.gz: 0bb63dba2c5ee6d608d7b4d5b22895538ea288dde9423fac5bf133c37b24bb3a00b68dd2329a1b1874d0293e755165d0ce033df72e319de3e7204d9461de151c
+  metadata.gz: b1fc2fe57cb22c234b12ffe3c0182030baa3be525971eaa7a2f21470e36f5ef9f6957919ba3675574c1159c79ff3b40f28b11167927ce8f852e70fed667f01b3
+  data.tar.gz: 1406056b1b4f566163829b91dd96822c1705286528581567f74d1c383146652a10e0788fd1b80bab81fa79088a32a65440c72483f70fc8c22ae073e9115f19fa

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.4.7
+
+* Bugfix: Accidentally removed the model parameter from the URL.
+
+## 0.4.6
+
+* Add InteractiveReport support.
+
 ## 0.4.5
 
 * Add #delete to client.

data/README.md

@@ -109,6 +109,19 @@ sale['channel'] = 4
 
 fulfil.put(model: sale_model, body: sale)
 ```
+### Interactive Reports
+
+As of v0.4.6, interactive report support exists in a basic form.
+You're able to execute reports with basic params. Responses are
+transformed to JSON structures.
+
+```ruby
+fulfil = Fulfil::Client.new
+
+report = Fulfil::Report.new(client: fulfil, report_name: 'account.tax.summary.ireport')
+
+report.execute(start_date: Date.new(2020, 12, 1), end_date: Date.new(2020, 12, 31))
+```
 
 ## Development
 

data/lib/fulfil/client.rb

@@ -11,8 +11,11 @@ module Fulfil
 
   class Client
     class NotAuthorizedError < StandardError; end
+
     class UnknownHTTPError < StandardError; end
+
     class ConnectionError < StandardError; end
+
     class ResponseError < StandardError; end
 
     def initialize(subdomain: SUBDOMAIN, token: OAUTH_TOKEN, headers: { 'X-API-KEY' => API_KEY }, debug: false)
@@ -71,7 +74,7 @@ module Fulfil
       parse(results: results)
     end
 
-    def put(model:, id:, endpoint: nil, body: {})
+    def put(model: nil, id: nil, endpoint: nil, body: {})
       uri = URI(model_url(model: model, id: id, endpoint: endpoint))
 
       result = request(verb: :put, endpoint: uri, json: body)
@@ -85,6 +88,12 @@ module Fulfil
       parse(result: result)
     end
 
+    def interactive_report(endpoint:, body: nil)
+      uri = URI("#{base_url}/model/#{endpoint}")
+      result = request(verb: :put, endpoint: uri, json: body)
+      parse(result: result)
+    end
+
     private
 
     def parse(result: nil, results: [])
@@ -103,15 +112,19 @@ module Fulfil
       results.map { |result| Fulfil::ResponseParser.parse(item: result) }
     end
 
+    def domain
+      "https://#{@subdomain}.fulfil.io"
+    end
+
     def base_url
-      "https://#{@subdomain}.fulfil.io/api/v2/model"
+      [domain, 'api', 'v2'].join('/')
     end
 
     def model_url(model:, id: nil, endpoint: nil)
-      [base_url, model, id, endpoint].compact.join('/')
+      [base_url, 'model', model, id, endpoint].compact.join('/')
     end
 
-    def request(verb: :get, endpoint:, **args)
+    def request(endpoint:, verb: :get, **args)
       response = client.request(verb, endpoint, args)
 
       if response.status.ok? || response.status.created?
@@ -131,8 +144,8 @@ module Fulfil
     rescue HTTP::ConnectionError => e
       puts "Couldn't connect"
       raise ConnectionError, "Can't connect to #{base_url}"
-    rescue HTTP::ResponseError => ex
-      raise ResponseError, "Can't process response: #{ex}"
+    rescue HTTP::ResponseError => e
+      raise ResponseError, "Can't process response: #{e}"
       []
     end
 

data/lib/fulfil/interactive_report.rb

@@ -0,0 +1,33 @@
+module Fulfil
+  class InteractiveReport
+    def initialize(client:, report:)
+      @client = client
+      @report = report
+    end
+
+    def execute(start_date:, end_date:)
+      @client.interactive_report(
+        endpoint: report_url,
+        body: [{
+          start_date: serialize_date(start_date),
+          end_date: serialize_date(end_date)
+        }]
+      )
+    end
+
+    private
+
+    def report_url
+      "#{@report}/execute"
+    end
+
+    def serialize_date(date)
+      {
+        __class__: 'date',
+        year: date.year,
+        month: date.month,
+        day: date.day
+      }
+    end
+  end
+end

data/lib/fulfil/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fulfil
-  VERSION = '0.4.5'
+  VERSION = '0.4.7'
 end

data/lib/fulfil.rb

@@ -1,6 +1,7 @@
 require 'fulfil/version'
 require 'fulfil/client'
 require 'fulfil/model'
+require 'fulfil/interactive_report'
 require 'fulfil/response_parser'
 
 module Fulfil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Chris Moore
@@ -111,6 +111,7 @@ files:
 - Rakefile
 - lib/fulfil.rb
 - lib/fulfil/client.rb
+- lib/fulfil/interactive_report.rb
 - lib/fulfil/model.rb
 - lib/fulfil/query.rb
 - lib/fulfil/response_parser.rb