vizion 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f000846e869a4edb42e9e9e6dcf90b901c2afaf923bdd4f82f7fe50a8af34f68
-  data.tar.gz: 285be0933a913e2e3561861b85e00e1a970fb8ff34589aa46639e87451510ec0
+  metadata.gz: 6957ac4f48e1c12e5839ba41799be135d16ea601fe2b345d1ca4fdc2696a7f00
+  data.tar.gz: c19d84f9a1407923cf1d9048919fa5c6f87f915d3f1e34b7ebc96981c423ecaf
 SHA512:
-  metadata.gz: e95c4af0805d25babcbb6965ba4efd768d43d5908d387baf88d54b559c930511c8a7b047ddd1e432e264ec245781d6113ac0a9fb29eaf265884c8c262aa1c7fd
-  data.tar.gz: b5f4580f2eb8f67d4d50caabe115a8e15ec786f23ce0e95ce4363cd663f704a52a8e03a4e10ceca56b310e13601e010e35ce20932e789faa148592507828e7a8
+  metadata.gz: 509ceddc5e5b2bbdef257bf35093ceafa93b8d7c1c817a1670cd9990c7afc473764af915b47a00bedab1fdd15d2855247ef43cb92725c1664c30c96f1495bd3d
+  data.tar.gz: b21e81626f43e1d0bf8417a9ffe6ecdcc9d72ae3dccff88e13bcdaf6bb3b745070adbcf038b27c0d454ab4599f991e3f589a7e40c6c77c1475ab68cbd824c193

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [lepepe] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/README.md

@@ -24,20 +24,35 @@ You'll need to generate an api key: [https://vizionapi.com/sign-up](https://vizi
 Initialize client and making request:
 
 ``` ruby
-client = Vizion::Client.new("X-API-Key")
+require 'vizion'
+client = Vizion::Client.new(api_key: "X-API-Key")
 client.carriers
 ```
+
+### Timeouts
+
+You may also set timeout on the client.
+
+```ruby 
+require 'vizion'
+client = Vtxkit::Client.new(api_key: "X-API-Key", timeout: 10, # response timeout in seconds)
+```
+
 ## List of methods
 
 ### Carriers
 List of all supported carriers, to view the list [click here](https://www.notion.so/afa65e3d79fb4a33bc5ce5c331576668?v=a7543be9963441b8aa1ad33962774b85).   
 
+Actions supported:   
+
 ```ruby
 client.carriers
 ```
 
 ### References
 
+Actions supported:   
+
 ```ruby
 client.all_references
 client.create_reference
@@ -45,9 +60,21 @@ client.reference(id)
 client.reference_updates(id)
 client.delete_reference(id)
 ```
+
+For the create_reference action include request body:
+
+```json
+{
+    "container_id": "CMAU4049810",
+    "scac": "CMAU",
+    "callback_url": "https://yourdomain.com/webhook"
+}
+```
+If no callback_url parameter is provided, you will need to fetch status updates from the reference_updates action.   
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vizion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/vertilux/vizion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -55,4 +82,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Vizion project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/vizion/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Vizion project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vertilux/vizion/blob/master/CODE_OF_CONDUCT.md).

data/lib/vizion/client.rb

@@ -10,12 +10,19 @@ module Vizion
     include Vizion::Client::Carriers
     include Vizion::Client::References
 
+    DEFAULT_TIMEOUT = 120
+
     base_uri "https://prod.vizionapi.com"
     format :json
 
-    def initialize(api_key = nil)
-      api_key ||= ENV["VIZION_API_KEY"]
-      self.class.default_options.merge!(headers: { 'X-API-Key' => "#{api_key}" })
+    def initialize(options = {})
+      @api_key = options[:api_key] || ENV["VIZION_API_KEY"]
+      @timeout = options[:timeout] || DEFAULT_TIMEOUT
+
+      self.class.default_options.merge!(
+        headers: { 'X-Api-Key' => @api_key },
+        timeout: @timeout
+      )
     end
   end
 end

data/lib/vizion/client/connection.rb

@@ -15,12 +15,25 @@ module Vizion
       end
 
       private
-
-      def request(http_method, path, options)
-        response = self.class.send(http_method, path, { body: options })
-        data = response.parsed_response
-      end
-
+        def request(http_method, path, options)
+          begin
+            response = self.class.send(http_method, path, { body: options })
+            status = response.code.to_i
+            case status
+              when 200 then data = response.parsed_response
+              when 400 then data = "Bad Request"
+              when 401 then data = "Unauthorized"
+              when 403 then data = "Forbidden"
+              when 500 then data = "Internal Server Error"
+              when 502 then data = "Bad Gateway"
+              when 503 then data = "Service Unavailable"
+            end
+          rescue Net::ReadTimeout => exception
+            data = "Error Read Timeout"
+          rescue Errno::ECONNREFUSED
+            data = "Connection refused"
+          end
+        end
     end
   end
 end

data/lib/vizion/version.rb

@@ -1,3 +1,3 @@
 module Vizion
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vizion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jose Perez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -111,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.21
 signing_key:
 specification_version: 4
 summary: Client library Vizion API.