fulfil-io 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d19d908e32866d5bb5f96696cc90f59724e7654374c34d49f49e376a117d9c29
-  data.tar.gz: ba380e30001c2409f404a36ea6335a8762ec993b45b431c08c5b5d703172e550
+  metadata.gz: 22ec67bfb2b90dbcdb4eef09efa189b25f11aada22ff2fa66d115b1c9cb26e06
+  data.tar.gz: 48675559980e3ae07eb4a10938cfec33df858c82126faf2152a7a6c069cf3a79
 SHA512:
-  metadata.gz: 7d60b09fcfb88fcf29e160d1c6acef304ce57134dff910f881166ddb5dac88c83a697e65132ca59778ec47695f5f346269154ac76b120d201781221128bf47a8
-  data.tar.gz: 7db725e451c38016cd63fda0ccbe46b9e1257236f660c021f3f649c9ca4dad3a80fe652143e526e79f29e0ea6f60453d9e50f43883292490653a64d4d8661760
+  metadata.gz: c1ac80544c088e239f250f937c5b5f20c95ac818bbe394f3e55b4c32d9800301f534bb3a922885c55ba870bb10f5448612a0cc181c6cbef9e4cd91dfa035d4c7
+  data.tar.gz: fbfb4ba1116956cdf9d3d2f2234fe53067ad31b9ffb87c36b62d01e1c3e1c31c84d7abfcbe29222b3aca58e097017bfd303f3903c1fc553d932ac55c44d64c1c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0
+
+* Add basic write support via `Fulfil::Client#post` and `Fulfil::Client#put`.
+
 ## 0.2.0
 
 - Make token optional and allow specifying headers at least for enabling authentication via 'X-API-KEY' header

data/README.md

@@ -28,9 +28,9 @@ Environment variables:
 - FULFIL_TOKEN - required for oauth bearer authentication
 - FULFIL_API_KEY - required for authentication via the X-API-KEY request header
 
-###Note: 
-
-When FULFIL_TOKEN is present, the FULFIL_API_KEY will be ignored. So, if oauth doesn't work, returning an Unauthorized error, to use the FULFIL_API_KEY, the FULFIL_TOKEN shouldn't be specified.
+**Note:** When FULFIL_TOKEN is present, the FULFIL_API_KEY will be ignored. So,
+if oauth doesn't work, returning an Unauthorized error, to use the
+FULFIL_API_KEY, the FULFIL_TOKEN shouldn't be specified.
 
 ```ruby
 require 'fulfil' # this is necessary only in case of running without bundler
@@ -68,6 +68,38 @@ pp sales
 #   "rec_name"=>""}]
 ```
 
+### Writing
+
+As of v0.3.0, we've added very basic support for creates and updates via
+`Fulfil::Client#post` and `Fulfil::Client#put`.
+
+*Create Example*
+
+```ruby
+fulfil = Fulfil::Client.new
+
+sale_model = Fulfil::Model.new(client: fulfil, model_name: 'sale.sale')
+
+sale = {
+  # Full Sale attributes here
+}
+
+fulfil.post(model: sale_model, body: sale)
+```
+
+*Update Example*
+
+```ruby
+fulfil = Fulfil::Client.new
+
+sale_model = Fulfil::Model.new(client: fulfil, model_name: 'sale.sale')
+sale = sale_model.find(id: 1234)
+
+sale['channel'] = 4
+
+fulfil.put(model: sale_model, body: sale)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/fulfil/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'http'
 require 'logger'
 require 'fulfil/response_parser'
@@ -50,9 +52,35 @@ module Fulfil
       parse(results: results)
     end
 
+    def post(model:, body: {})
+      uri = URI(model_url(model: model))
+
+      results = request(verb: :post, endpoint: uri, json: body)
+      parse(results: results)
+    end
+
+    def put(model:, id:, endpoint: nil, body: {})
+      uri = URI(model_url(model: model, id: id, endpoint: endpoint))
+
+      result = request(verb: :put, endpoint: uri, json: body)
+      parse(result: result)
+    end
+
     private
 
     def parse(result: nil, results: [])
+      if result.present?
+        parse_single(result: result)
+      else
+        parse_multiple(results: results)
+      end
+    end
+
+    def parse_single(result:)
+      Fulfil::ResponseParser.parse(item: result)
+    end
+
+    def parse_multiple(results:)
       results.map { |result| Fulfil::ResponseParser.parse(item: result) }
     end
 
@@ -60,26 +88,30 @@ module Fulfil
       "https://#{@subdomain}.fulfil.io/api/v2/model"
     end
 
-    def model_url(model:)
-      [base_url, model].join('/')
+    def model_url(model:, id: nil, endpoint: nil)
+      [base_url, model, id, endpoint].compact.join('/')
     end
 
     def request(verb: :get, endpoint:, **args)
       response = client.request(verb, endpoint, args)
 
-      if response.status.ok?
+      if response.status.ok? || response.status.created?
         response.parse
       elsif response.code == 401
-        raise StandardError, "Not authorized"
+        raise StandardError, 'Not authorized'
       else
-        pp response.parse
-        raise StandardError, "Invalid response"
+        puts response.body.to_s
+        raise Error, 'Error encountered while processing response:'
       end
-    rescue HTTP::ConnectionError => ex
+    rescue HTTP::Error => e
+      puts e
+      raise Error, 'Unhandled HTTP error encountered'
+    rescue HTTP::ConnectionError => e
       puts "Couldn't connect"
       raise Error, "Can't connect to #{base_url}"
     rescue HTTP::ResponseError => ex
       raise Error, "Can't process response: #{ex}"
+      []
     end
 
     def client

data/lib/fulfil/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fulfil-io
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Moore
 - Kat Fairbanks
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -95,7 +95,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - chris@knowndecimal.com
 executables: []
@@ -119,7 +119,7 @@ homepage: https://github.com/knowndecimal/fulfil
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Interact with the Fulfil.io API
 test_files: []