gbro_teemill 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286a14ea843e38f76c80e9778d78fd58620cecc361fc72943cf305ec8a64d844
-  data.tar.gz: bfa25ab16491c0b5b595040bbf987cd60b34c2b7208e0b7909b4c0f6512aba91
+  metadata.gz: 7dfbca27199726f1815775c8a98e6b333c8dfe7466b7fb3e84743e6f2f03ddd5
+  data.tar.gz: 84985619da844d97160235b03b53aefe689a3737b5cae9af7aa476f9f8499686
 SHA512:
-  metadata.gz: 9ea8a683a4b9b8063ae3bf3afde9633821d89c2447a33345a28f551be847230180b7db5bc02ec61251cdeef67187b9938bed95834937131b5e94a7d80c8b0387
-  data.tar.gz: 07d425a9c5a7c68a0e4855612f7634b21b9bdf6c1cf91e27535555565ec7bbf230059ce423b63ff9e4d6808ce493e4afba00f8d8f69b74f6f0e9fcc494c5a495
+  metadata.gz: 6abd81aeda658e30bf3895d0f3726be4063c9bde988c155f7fa65304fe80c5a40b6def7e4b00c4954c21598945f65878bf687d951bb3c87322220ebb8957fd4f
+  data.tar.gz: d4cfda12dad2efcede45b0a5f5af8bc3a3ddd9a31432469edd6ee56f6216376c4adbf0afcf9f5367e5c7e3d7f3e49898d95b56c2c64e5159bf8421102a080bb9

data/lib/config.rb

@@ -1,10 +1,15 @@
 module Teemill
   class Config
-    attr_accessor :api_key, :api_base, :api_version, :bearer_token
+    attr_accessor :api_key,
+      :api_base,
+      :api_version,
+      :legacy_api_key,
+      :legacy_api_base
 
     def initialize
       @api_version = 1
       @api_base = 'https://api.teemill.com'
+      @legacy_api_base = 'https://teemill.com'
     end
   end
 end

data/lib/debug.rb

@@ -0,0 +1,13 @@
+require 'colorize'
+
+module Teemill
+  class Debug
+    attr_accessor :debug_mode
+
+    def self.log(string, color)
+      return unless Teemill.debug_mode
+
+      STDERR.puts string.public_send(color)
+    end
+  end
+end

data/lib/errors/documented_error.rb

@@ -0,0 +1,35 @@
+require 'colorize'
+
+module Teemill
+  class DocumentedError < StandardError
+    def initialize
+      STDERR.puts message.red
+      STDERR.puts "See: #{docs_reference}".yellow
+      super(message)
+    end
+
+    def message
+      "Unknown error occurred"
+    end
+
+    def docs_reference
+      "#{docs_domain}#{docs_path}#{docs_query_params}#{docs_hash_mark}"
+    end
+
+    def docs_domain
+      "https://teemill.com"
+    end
+
+    def docs_path
+      "/api-docs"
+    end
+
+    def docs_query_params
+      "?lang=ruby"
+    end
+
+    def docs_hash_mark
+      "#"
+    end
+  end
+end

data/lib/errors/errors.rb

@@ -0,0 +1,5 @@
+require_relative './documented_error'
+require_relative './invalid_request_error'
+require_relative './invalid_response_error'
+require_relative './missing_credentials_error'
+require_relative './missing_legacy_credentials_error'

data/lib/errors/invalid_request_error.rb

@@ -0,0 +1,4 @@
+module Teemill
+  class InvalidRequestError < StandardError
+  end
+end

data/lib/errors/invalid_response_error.rb

@@ -0,0 +1,5 @@
+module Teemill
+  class InvalidResponseError < StandardError
+
+  end
+end

data/lib/errors/missing_credentials_error.rb

@@ -0,0 +1,13 @@
+require 'colorize'
+
+module Teemill
+  class MissingCredentialsError < Teemill::DocumentedError
+    def message
+      "No API key has been provided"
+    end
+
+    def docs_hash_mark
+      "#authentication"
+    end
+  end
+end

data/lib/errors/missing_legacy_credentials_error.rb

@@ -0,0 +1,13 @@
+require 'colorize'
+
+module Teemill
+  class MissingLegacyCredentialsError < Teemill::MissingCredentialsError
+    def message
+      "No legacy API key has been provided"
+    end
+
+    def docs_hash_mark
+      "#legacy_authentication"
+    end
+  end
+end

data/lib/{teemill.rb → gbro_teemill.rb}

@@ -1,9 +1,17 @@
+
+require_relative './errors/errors'
+require_relative './resources/request/requests'
 require_relative './resources/resources'
 require_relative './config'
+require_relative './debug'
 require 'forwardable'
 
+#
+# An SDK for the Teemill API
+#
 module Teemill
   @config = Config.new
+  @debug = Debug.new
 
   class << self
     extend Forwardable
@@ -11,8 +19,10 @@ module Teemill
     attr_reader :config
 
     def_delegators :@config, :api_key, :api_key=
-    def_delegators :@config, :bearer_token, :bearer_token=
+    def_delegators :@config, :legacy_api_key, :legacy_api_key=
     def_delegators :@config, :api_version, :api_version=
     def_delegators :@config, :api_base, :api_base=
+    def_delegators :@config, :legacy_api_base, :legacy_api_base=
+    def_delegators :@debug, :debug_mode, :debug_mode=
   end
 end

data/lib/resources/base_resource.rb

@@ -0,0 +1,34 @@
+require 'ostruct'
+
+module Teemill
+  class BaseResource
+    include Teemill::AuthenticatedRequestHandler
+
+    def self.create(options)
+      obj = new
+
+      Teemill::Debug.log("Creating: #{obj.class.name}", 'cyan')
+
+      raise Teemill::InvalidRequestError, 'No create request exists for this resource' unless obj.create_resource_url
+
+      response = obj.send_post_request(
+        obj.create_resource_url,
+        options
+      )
+
+      obj.assign_properties(response)
+
+      obj
+    end
+
+    def assign_properties(props)
+      props.each_key do |key|
+        value = props[key]
+
+        value = OpenStruct.new(value) if value.instance_of?(Hash)
+
+        send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/resources/custom_product.rb

@@ -1,12 +1,17 @@
-require_relative './base/bearer_token_authenticated_resource'
+# require_relative './request/bearer_token_authenticated_request_handler'
+
 
 module Teemill
-  class CustomProduct < BearerTokenAuthenticatedResource
-    def self.create(options)
-      self.new.send_post_request(
-        '/product/create',
-        options
-      )
+  #
+  # Used to create Custom Products
+  #
+  class CustomProduct < Teemill::BaseResource
+    include Teemill::LegacyAuthenticatedRequestHandler
+
+    attr_accessor :id, :url, :image, :colours, :name, :price
+
+    def create_resource_url
+      '/product/create'
     end
   end
 end

data/lib/resources/request/authenticated_request_handler.rb

@@ -0,0 +1,72 @@
+require 'json'
+require 'uri'
+require 'net/http'
+require 'openssl'
+
+module Teemill
+  module AuthenticatedRequestHandler
+    def base_url
+      "#{Teemill.api_base}/v#{Teemill.api_version}"
+    end
+
+    def authenticated_request_headers
+      { Authorization: Teemill.api_key }
+    end
+
+    def send_request(request_url, data, method = 'GET')
+      check_credentials
+      Teemill::Debug.log("Dispatching: #{method} #{base_url}", 'yellow')
+      url = URI("#{base_url}#{request_url}")
+
+      http = create_http(url)
+
+      request = create_request_object(url, data, method)
+
+      response = http.request(request)
+      Teemill::Debug.log("Received: #{response.code} #{response.msg}", 'yellow')
+      raise Teemill::InvalidResponseError, "Error #{response.code}: #{response.msg}" unless response.code == "200"
+
+      JSON.parse(response.read_body)
+    end
+
+    def send_post_request(request_url, data)
+      send_request(request_url, data, 'POST')
+    end
+
+    def send_get_request(request_url, data)
+      send_request(request_url, data, 'GET')
+    end
+
+    private
+
+    def check_credentials
+      raise Teemill::MissingCredentialsError unless Teemill.api_key
+    end
+
+    def create_http(url)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http
+    end
+
+    def create_request_object(url, data, method)
+      request = Net::HTTP::Post.new(url) if method == 'POST'
+      request = Net::HTTP::Get.new(url) if method == 'GET'
+
+      request['Content-Type'] = 'application/json'
+
+      add_authentication_headers(request)
+
+      request.body = JSON.generate(data) if method == 'POST'
+
+      request
+    end
+
+    def add_authentication_headers(request)
+      authenticated_request_headers.each_key do |header|
+        request[header] = authenticated_request_headers[header]
+      end
+    end
+  end
+end

data/lib/resources/request/legacy_authenticated_request_handler.rb

@@ -0,0 +1,18 @@
+module Teemill
+  module LegacyAuthenticatedRequestHandler
+    include Teemill::AuthenticatedRequestHandler
+    def authenticated_request_headers
+      { Authorization: "Bearer #{Teemill.legacy_api_key}" }
+    end
+
+    def base_url
+      "#{Teemill.legacy_api_base}/omnis/v3"
+    end
+
+    private
+    
+    def check_credentials
+      raise Teemill::MissingLegacyCredentialsError unless Teemill.legacy_api_key
+    end
+  end
+end

data/lib/resources/request/requests.rb

@@ -0,0 +1,2 @@
+require_relative './authenticated_request_handler'
+require_relative './legacy_authenticated_request_handler'

data/lib/resources/resources.rb

@@ -1 +1,2 @@
+require_relative './base_resource'
 require_relative './custom_product'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gbro_teemill
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - G-Bro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-11-05 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -17,15 +17,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/config.rb
-- lib/resources/base/base_resource.rb
-- lib/resources/base/bearer_token_authenticated_resource.rb
+- lib/debug.rb
+- lib/errors/documented_error.rb
+- lib/errors/errors.rb
+- lib/errors/invalid_request_error.rb
+- lib/errors/invalid_response_error.rb
+- lib/errors/missing_credentials_error.rb
+- lib/errors/missing_legacy_credentials_error.rb
+- lib/gbro_teemill.rb
+- lib/resources/base_resource.rb
 - lib/resources/custom_product.rb
+- lib/resources/request/authenticated_request_handler.rb
+- lib/resources/request/legacy_authenticated_request_handler.rb
+- lib/resources/request/requests.rb
 - lib/resources/resources.rb
-- lib/teemill.rb
 homepage: https://teemill.com/api-docs/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/G-Bro/teemill-ruby-sdk
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -41,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: An SDK for the Teemill API

data/lib/resources/base/base_resource.rb

@@ -1,53 +0,0 @@
-require 'json'
-require 'uri'
-require 'net/http'
-require 'openssl'
-
-class BaseResource
-  def base_url
-    "#{Teemill.api_base}/v#{Teemill.api_version}"
-  end
-
-  def authenticated_request_headers
-    { Authorization: Teemill.api_key }
-  end
-
-  def add_authentication_headers(request)
-    authenticated_request_headers.each_key do |header|
-      request[header] = authenticated_request_headers[header]
-    end
-  end
-
-  def send_request(request_url, data, method = 'GET')
-    url = URI("#{base_url}#{request_url}")
-
-    http = create_http(url)
-
-    request = Net::HTTP::Post.new(url) if method == 'POST'
-    request = Net::HTTP::Get.new(url) if method == 'GET'
-
-    request['Content-Type'] = 'application/json'
-
-    add_authentication_headers(request)
-
-    request.body = JSON.generate(data) if method == 'POST'
-
-    response = http.request(request)
-    JSON.parse(response.read_body)
-  end
-
-  def create_http(url)
-    http = Net::HTTP.new(url.host, url.port)
-    http.use_ssl = true
-    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-    http
-  end
-
-  def send_post_request(request_url, data)
-    send_request(request_url, data, 'POST')
-  end
-
-  def send_get_request(request_url, data)
-    send_request(request_url, data, 'GET')
-  end
-end

data/lib/resources/base/bearer_token_authenticated_resource.rb

@@ -1,11 +0,0 @@
-require_relative './base_resource'
-
-class BearerTokenAuthenticatedResource < BaseResource
-  def authenticated_request_headers
-    { Authorization: "Bearer #{Teemill.bearer_token}" }
-  end
-
-  def base_url
-    "#{Teemill.api_base}/omnis/v3"
-  end
-end