tuneuptechnology 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0dccd4117b67f200579ff7db598088ba6647feeee455671d3264f7e36ff0131
-  data.tar.gz: 2db139f32bcdfd879c5da9da709dd19ebf02b6e9886d492f20a73f1251c1cbba
+  metadata.gz: fe3fcf0a838933bfff1df5e091c4b76fe66b2e46002c2916be492b094896f479
+  data.tar.gz: 3dcef4d3dddee741e18ed341ea7a8be45c3cd8ec9cf2a911daaa2903478ee9ec
 SHA512:
-  metadata.gz: 1574e146cb63a2a89a32c74af1fc34f74b747c6350afa21344552f12162b032ebaefce9edc141a7dee48d3d394f83f7c949fc3aca4ac66ad4b9ffbaf14db749d
-  data.tar.gz: 6d662e4d337a420bba6aace8f0ded9f061d15644a4a1b6dc46698f4a35c7fcf7284dbf380a565aec235c55a3485ffef5e9e50177ef69ed7aa6cd5f15c7a61e5f
+  metadata.gz: 9c5bc452b0cbec6e072e1d3c927e8f1e6f63815a92d1ccd5398228a2393a1a12da1e981edab27ebae6b662d541e7b0f80c2eb4d459fd378afbabaa4e99526a3b
+  data.tar.gz: 25500ffa02d4decac5fc39f04c9651881214da0af71ac2ca33ce3860185145b673e4dc43377518980b29f6293e9287c38a22f388ddc67d50f6221c03f312313c

data/lib/tuneuptechnology.rb

@@ -1,38 +1,7 @@
 # frozen_string_literal: true
 
-require 'rest-client'
-require 'json'
-
-# Tuneup Technology Resources
-require 'tuneuptechnology/customer'
-require 'tuneuptechnology/inventory'
-require 'tuneuptechnology/location'
-require 'tuneuptechnology/ticket'
-
-module TuneupTechnology
-  # Build the HTTP client for the library
-  class Client
-    @base_url = 'https://app.tuneuptechnology.com/api/'
-    class << self
-      attr_reader :base_url
-    end
-
-    @version = '1.0.0'
-    class << self
-      attr_reader :version
-    end
-
-    @headers = {
-      'Content-Type' => 'application/json',
-      'User-Agent' => "TuneupTechnologyApp/RubyClient/#{Client.version}"
-    }
-    class << self
-      attr_reader :headers
-    end
-
-    def self.post(data, endpoint)
-      response = RestClient.post(endpoint, data.to_json, headers)
-      JSON.pretty_generate(JSON.parse(response))
-    end
-  end
-end
+require_relative 'tuneuptechnology/client'
+require_relative 'tuneuptechnology/customers'
+require_relative 'tuneuptechnology/inventory'
+require_relative 'tuneuptechnology/locations'
+require_relative 'tuneuptechnology/tickets'

data/lib/tuneuptechnology/client.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+
+module TuneupTechnology
+  # The Client initializes everything needed to use this client library
+  class Client
+    attr_reader :email, :api_key, :base_url, :timeout, :version, :headers
+
+    def initialize(email = nil, api_key = nil, base_url = 'https://app.tuneuptechnology.com/api', timeout = 10)
+      @@email = email
+      @@api_key = api_key
+      @base_url = base_url
+      @timeout = timeout
+      @version = '2.0.0'
+
+      raise NameError, 'email and api_key are required to create a Client.' if @@email.nil? || @@api_key.nil?
+    end
+
+    def customers
+      TuneupTechnology::Customers.new(@base_url, :make_http_request)
+    end
+
+    def inventory
+      TuneupTechnology::Inventory.new(@base_url, :make_http_request)
+    end
+
+    def locations
+      TuneupTechnology::Locations.new(@base_url, :make_http_request)
+    end
+
+    def tickets
+      TuneupTechnology::Tickets.new(@base_url, :make_http_request)
+    end
+
+    # Build the HTTP client for the library
+    def self.make_http_request(method, endpoint, data = nil)
+      headers = {
+        'Accept' => 'application/json',
+        'User-Agent' => "TuneupTechnologyApp/RubyClient/#{@version}",
+        'Email' => @@email,
+        'Api-Key' => @@api_key
+      }
+
+      begin
+        response = RestClient::Request.execute(
+          method: method,
+          url: endpoint,
+          payload: data.to_json,
+          headers: headers,
+          timeout: @timeout
+        )
+
+        JSON.parse(response.body)
+      rescue RestClient::ExceptionWithResponse => e
+        e.response
+      end
+    end
+  end
+end

data/lib/tuneuptechnology/customers.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module TuneupTechnology
+  # The Customers object
+  class Customers < Client
+    attr_reader :base_url, :make_http_request
+
+    def initialize(base_url, make_http_request)
+      @base_url = base_url
+      @make_http_request = make_http_request
+    end
+
+    # Create a customer
+    def create(data)
+      endpoint = "#{@base_url}/customers"
+      Client.make_http_request('post', endpoint, data)
+    end
+
+    # Retrieve all customer records
+    def all
+      endpoint = "#{@base_url}/customers"
+      Client.make_http_request('get', endpoint)
+    end
+
+    # Retrieve a single customer record
+    def retrieve(id)
+      endpoint = "#{@base_url}/customers/#{id}"
+      Client.make_http_request('get', endpoint)
+    end
+
+    # Update a customer record
+    def update(id, data)
+      endpoint = "#{@base_url}/customers/#{id}"
+      Client.make_http_request('patch', endpoint, data)
+    end
+
+    # Delete a customer record
+    def delete(id)
+      endpoint = "#{@base_url}/customers/#{id}"
+      Client.make_http_request('delete', endpoint)
+    end
+  end
+end

data/lib/tuneuptechnology/inventory.rb

@@ -1,36 +1,43 @@
 # frozen_string_literal: true
 
 module TuneupTechnology
-  # Methods for the Inventory object
-  class Inventory
-    # Create an inventory item
-    def self.create(data)
-      endpoint = Client.base_url + 'inventory/create'
-      Client.post(data, endpoint)
+  # The Inventory object
+  class Inventory < Client
+    attr_reader :base_url, :make_http_request
+
+    def initialize(base_url, make_http_request)
+      @base_url = base_url
+      @make_http_request = make_http_request
+    end
+
+    # Create an inventory record
+    def create(data)
+      endpoint = "#{@base_url}/inventory"
+      Client.make_http_request('post', endpoint, data)
     end
 
     # Retrieve all inventory records
-    def self.all(data)
-      endpoint = Client.base_url + 'inventory'
-      Client.post(data, endpoint)
+    def all
+      endpoint = "#{@base_url}/inventory"
+      Client.make_http_request('get', endpoint)
     end
 
     # Retrieve a single inventory record
-    def self.retrieve(data)
-      endpoint = Client.base_url + 'inventory/' + data['id'].to_s
-      Client.post(data, endpoint)
+    def retrieve(id)
+      endpoint = "#{@base_url}/inventory/#{id}"
+      Client.make_http_request('get', endpoint)
     end
 
     # Update an inventory record
-    def self.update(data)
-      endpoint = Client.base_url + 'inventory/' + data['id'].to_s + '/update'
-      Client.post(data, endpoint)
+    def update(id, data)
+      endpoint = "#{@base_url}/inventory/#{id}"
+      Client.make_http_request('patch', endpoint, data)
     end
 
     # Delete an inventory record
-    def self.delete(data)
-      endpoint = Client.base_url + 'inventory/' + data['id'].to_s + '/delete'
-      Client.post(data, endpoint)
+    def delete(id)
+      endpoint = "#{@base_url}/inventory/#{id}"
+      Client.make_http_request('delete', endpoint)
     end
   end
 end

data/lib/tuneuptechnology/locations.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module TuneupTechnology
+  # The Locations object
+  class Locations < Client
+    attr_reader :base_url, :make_http_request
+
+    def initialize(base_url, make_http_request)
+      @base_url = base_url
+      @make_http_request = make_http_request
+    end
+
+    # Create a location
+    def create(data)
+      endpoint = "#{@base_url}/locations"
+      Client.make_http_request('post', endpoint, data)
+    end
+
+    # Retrieve all location records
+    def all
+      endpoint = "#{@base_url}/locations"
+      Client.make_http_request('get', endpoint)
+    end
+
+    # Retrieve a single location record
+    def retrieve(id)
+      endpoint = "#{@base_url}/locations/#{id}"
+      Client.make_http_request('get', endpoint)
+    end
+
+    # Update a location record
+    def update(id, data)
+      endpoint = "#{@base_url}/locations/#{id}"
+      Client.make_http_request('patch', endpoint, data)
+    end
+
+    # Delete a location record
+    def delete(id)
+      endpoint = "#{@base_url}/locations/#{id}"
+      Client.make_http_request('delete', endpoint)
+    end
+  end
+end

data/lib/tuneuptechnology/tickets.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module TuneupTechnology
+  # The tickets object
+  class Tickets < Client
+    attr_reader :base_url, :make_http_request
+
+    def initialize(base_url, make_http_request)
+      @base_url = base_url
+      @make_http_request = make_http_request
+    end
+
+    # Create a ticket
+    def create(data)
+      endpoint = "#{@base_url}/tickets"
+      Client.make_http_request('post', endpoint, data)
+    end
+
+    # Retrieve all ticket records
+    def all
+      endpoint = "#{@base_url}/tickets"
+      Client.make_http_request('get', endpoint)
+    end
+
+    # Retrieve a single ticket record
+    def retrieve(id)
+      endpoint = "#{@base_url}/tickets/#{id}"
+      Client.make_http_request('get', endpoint)
+    end
+
+    # Update a ticket record
+    def update(id, data)
+      endpoint = "#{@base_url}/tickets/#{id}"
+      Client.make_http_request('patch', endpoint, data)
+    end
+
+    # Delete a ticket record
+    def delete(id)
+      endpoint = "#{@base_url}/tickets/#{id}"
+      Client.make_http_request('delete', endpoint)
+    end
+  end
+end

metadata

@@ -1,60 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: tuneuptechnology
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
-- NCR4
+- Tuneup Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: |-
   This library allows you to interact with the customers,
       tickets, inventory, and locations objects without needing to do the hard
       work of binding your calls and data to endpointspec. Simply call an action
       such as `Customer.create` and pass some data and let the library do
       the rest.
-email: justin@ncr4.com
+email: tuneuptechnology@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/tuneuptechnology.rb
-- lib/tuneuptechnology/customer.rb
+- lib/tuneuptechnology/client.rb
+- lib/tuneuptechnology/customers.rb
 - lib/tuneuptechnology/inventory.rb
-- lib/tuneuptechnology/location.rb
-- lib/tuneuptechnology/ticket.rb
-homepage: https://github.com/ncr4/tuneuptechnology-ruby
+- lib/tuneuptechnology/locations.rb
+- lib/tuneuptechnology/tickets.rb
+homepage: https://github.com/tuneuptechnology/tuneuptechnology-ruby
 licenses:
 - MIT
 metadata: {}
@@ -66,14 +137,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: The Ruby client library for the Tuneup Technology App.

data/lib/tuneuptechnology/customer.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module TuneupTechnology
-  # Methods for the Customer object
-  class Customer
-    # Create a customer
-    def self.create(data)
-      endpoint = Client.base_url + 'customers/create'
-      Client.post(data, endpoint)
-    end
-
-    # Retrieve all customer records
-    def self.all(data)
-      endpoint = Client.base_url + 'customers'
-      Client.post(data, endpoint)
-    end
-
-    # Retrieve a single customer record
-    def self.retrieve(data)
-      endpoint = Client.base_url + 'customers/' + data['id'].to_s
-      Client.post(data, endpoint)
-    end
-
-    # Update a customer record
-    def self.update(data)
-      endpoint = Client.base_url + 'customers/' + data['id'].to_s + '/update'
-      Client.post(data, endpoint)
-    end
-
-    # Delete a customer record
-    def self.delete(data)
-      endpoint = Client.base_url + 'customers/' + data['id'].to_s + '/delete'
-      Client.post(data, endpoint)
-    end
-  end
-end

data/lib/tuneuptechnology/location.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module TuneupTechnology
-  # Methods for the Location object
-  class Location
-    # Create a location
-    def self.create(data)
-      endpoint = Client.base_url + 'locations/create'
-      Client.post(data, endpoint)
-    end
-
-    # Retrieve all location records
-    def self.all(data)
-      endpoint = Client.base_url + 'locations'
-      Client.post(data, endpoint)
-    end
-
-    # Retrieve a single location record
-    def self.retrieve(data)
-      endpoint = Client.base_url + 'locations/' + data['id'].to_s
-      Client.post(data, endpoint)
-    end
-
-    # Update a location record
-    def self.update(data)
-      endpoint = Client.base_url + 'locations/' + data['id'].to_s + '/update'
-      Client.post(data, endpoint)
-    end
-
-    # Delete a location record
-    def self.delete(data)
-      endpoint = Client.base_url + 'locations/' + data['id'].to_s + '/delete'
-      Client.post(data, endpoint)
-    end
-  end
-end

data/lib/tuneuptechnology/ticket.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module TuneupTechnology
-  # Methods for the Ticket object
-  class Ticket
-    # Create a ticket
-    def self.create(data)
-      endpoint = Client.base_url + 'tickets/create'
-      Client.post(data, endpoint)
-    end
-
-    # Retrieve all ticket records
-    def self.all(data)
-      endpoint = Client.base_url + 'tickets'
-      Client.post(data, endpoint)
-    end
-
-    # Retrieve a single ticket record
-    def self.retrieve(data)
-      endpoint = Client.base_url + 'tickets/' + data['id'].to_s
-      Client.post(data, endpoint)
-    end
-
-    # Update a ticket record
-    def self.update(data)
-      endpoint = Client.base_url + 'tickets/' + data['id'].to_s + '/update'
-      Client.post(data, endpoint)
-    end
-
-    # Delete a ticket record
-    def self.delete(data)
-      endpoint = Client.base_url + 'tickets/' + data['id'].to_s + '/delete'
-      Client.post(data, endpoint)
-    end
-  end
-end