shipengine_ruby 0.0.1

data/lib/shipengine/faraday/raise_http_exception.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module ShipEngine
+  module FaradayMiddleware
+    class RaiseHttpException < Faraday::Middleware
+      def call(env)
+        @app.call(env).on_complete do |response|
+          status_code = response[:status].to_i
+          if [400, 401, 404, 500, 502, 503, 504].include?(status_code)
+            raise ShipEngine::Exceptions::ShipEngineError.new(
+              message: error_body(response[:body]),
+              source: error_source(response[:body]),
+              type: error_type(response[:body]),
+              code: error_code(response[:body]),
+              url: response[:url].to_s
+            )
+          elsif [429].include?(status_code)
+            raise ShipEngine::Exceptions::RateLimitError.new(
+              retries: env.request_headers["Retries"].to_i,
+              source: error_source(response[:body])
+            )
+          end
+        end
+      end
+
+      private
+
+      def error_message_400(response)
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{response[:status]}#{error_body(response[:body])}"
+      end
+
+      def error_body(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          body = JSON.parse(body)
+        end
+
+        if body.nil?
+          nil
+        elsif body["errors"] && !body["errors"].empty?
+          body["errors"][0]["message"]
+        end
+      end
+
+      def error_source(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          body = JSON.parse(body)
+        end
+
+        if body.nil?
+          nil
+        elsif body["errors"] && !body["errors"].empty?
+          body["errors"][0]["error_source"]
+        end
+      end
+
+      def error_type(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          body = JSON.parse(body)
+        end
+
+        if body.nil?
+          nil
+        elsif body["errors"] && !body["errors"].empty?
+          body["errors"][0]["error_type"]
+        end
+      end
+
+      def error_code(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          body = JSON.parse(body)
+        end
+
+        if body.nil?
+          nil
+        elsif body["errors"] && !body["errors"].empty?
+          body["errors"][0]["error_code"]
+        end
+      end
+    end
+  end
+end

data/lib/shipengine/utils/validate.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Utils
+    module Validate
+      class << self
+        def not_nil(field, value)
+          return unless value.nil?
+
+          raise ShipEngine::Exceptions.required_error(field_name: field)
+        end
+
+        def not_nil_or_empty_str(field, value)
+          not_nil(field, value)
+          return unless value == ""
+
+          raise ShipEngine::Exceptions.required_error(field_name: field)
+        end
+
+        def str(field, value)
+          not_nil(field, value)
+          return if value.is_a?(String)
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be a String.")
+        end
+
+        def non_empty_str(field, value)
+          str(field, value)
+          return unless value.empty?
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} cannot be empty.")
+        end
+
+        def non_whitespace_str(field, value)
+          str(field, value)
+          return unless value.strip.empty?
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} cannot be all whitespace.")
+        end
+
+        def hash(field, value)
+          not_nil(field, value)
+          return if value.is_a?(Hash)
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be Hash.")
+        end
+
+        def bool(field, value)
+          not_nil(field, value)
+          return if [true, false].include?(value)
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be a Boolean.")
+        end
+
+        def number(field, value)
+          not_nil(field, value)
+          return if value.is_a?(Numeric)
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be Numeric.")
+        end
+
+        def int(field, value)
+          number(field, value)
+          return if value.to_i == value
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be a whole number.")
+        end
+
+        def non_neg_int(field, value)
+          int(field, value)
+          return if value >= 0
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be zero or greater.")
+        end
+
+        def positive_int(field, value)
+          int(field, value)
+          return if value.positive?
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be greater than zero.")
+        end
+
+        def array(field, value)
+          not_nil(field, value)
+
+          return if value.is_a?(Array)
+
+          raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be an Array.")
+        end
+
+        def array_of_str(field, value)
+          array(field, value)
+          value.each do |v|
+            next if v.is_a?(String)
+
+            raise ShipEngine::Exceptions.invalid_field_value_error(message: "#{field} must be an Array of Strings.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shipengine/utils.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "shipengine/utils/validate"

data/lib/shipengine/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module VERSION
+    VERSION = "0.0.1"
+  end
+end

data/lib/shipengine.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "shipengine/client"
+require "shipengine/configuration"
+require "shipengine/constants"
+require "shipengine/domains"
+require "shipengine/enums"
+require "shipengine/exceptions"
+require "shipengine/utils"
+require "shipengine/version"
+
+module ShipEngine
+  # Configures global settings for ShipEngine
+  #   ShipEngine.configure do |config|
+  #     config.api_key = 'api-key'
+  #   end
+  class << self
+    def configure
+      yield configs if block_given?
+    end
+
+    def configs
+      @configs ||= Configuration.new
+    end
+  end
+end

data/shipengine.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shipengine/version"
+
+Gem::Specification.new do |spec|
+  spec.name                   = "shipengine_ruby"
+  spec.summary                = "Ruby SDK for ShipEngine"
+  spec.homepage               = "https://github.com/MuhmdRaouf/shipengine"
+  spec.license                = "MIT"
+
+  spec.email                  = ["mohammed@raouf.me"]
+  spec.authors                = ["Mohammed Abdel Raouf"]
+
+  spec.version                = ShipEngine::VERSION::VERSION
+  spec.platform               = Gem::Platform::RUBY
+  spec.required_ruby_version  = ">= 2.5"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("faraday", "~> 1.0")
+  spec.add_runtime_dependency("faraday_middleware", "~> 1.0")
+  spec.add_runtime_dependency("hashie", "~> 3.4")
+
+  spec.add_development_dependency("bundler", "~> 1.17")
+  spec.add_development_dependency("pry", "~> 0.14")
+  spec.add_development_dependency("rake", "~> 13.0")
+  spec.add_development_dependency("rspec", "~> 3.12")
+  spec.add_development_dependency("rubocop", "~> 1.28")
+  spec.add_development_dependency("rubocop-performance", "~> 1.13")
+  spec.add_development_dependency("rubocop-shopify", "~> 2.5")
+  spec.add_development_dependency("webmock", "~> 3.18")
+end

metadata

@@ -0,0 +1,249 @@
+--- !ruby/object:Gem::Specification
+name: shipengine_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mohammed Abdel Raouf
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: 
+email:
+- mohammed@raouf.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shipengine.rb
+- lib/shipengine/client.rb
+- lib/shipengine/configuration.rb
+- lib/shipengine/constants.rb
+- lib/shipengine/domains.rb
+- lib/shipengine/domains/addresses.rb
+- lib/shipengine/domains/batches.rb
+- lib/shipengine/domains/carriers.rb
+- lib/shipengine/domains/carriers_accounts.rb
+- lib/shipengine/domains/labels.rb
+- lib/shipengine/domains/manifests.rb
+- lib/shipengine/domains/package_pickups.rb
+- lib/shipengine/domains/package_types.rb
+- lib/shipengine/domains/rates.rb
+- lib/shipengine/domains/service_points.rb
+- lib/shipengine/domains/shipments.rb
+- lib/shipengine/domains/shipsurance.rb
+- lib/shipengine/domains/tags.rb
+- lib/shipengine/domains/tokens.rb
+- lib/shipengine/domains/tracking.rb
+- lib/shipengine/domains/warehouses.rb
+- lib/shipengine/domains/webhooks.rb
+- lib/shipengine/enums.rb
+- lib/shipengine/enums/address_residential_indicator_types.rb
+- lib/shipengine/enums/address_status.rb
+- lib/shipengine/enums/batch_status.rb
+- lib/shipengine/enums/carriers_names.rb
+- lib/shipengine/enums/label_status.rb
+- lib/shipengine/enums/message_types.rb
+- lib/shipengine/enums/validate_address_types.rb
+- lib/shipengine/enums/webhooks_types.rb
+- lib/shipengine/errors/error_code.rb
+- lib/shipengine/errors/error_source.rb
+- lib/shipengine/errors/error_type.rb
+- lib/shipengine/exceptions.rb
+- lib/shipengine/faraday/raise_http_exception.rb
+- lib/shipengine/utils.rb
+- lib/shipengine/utils/validate.rb
+- lib/shipengine/version.rb
+- shipengine.gemspec
+homepage: https://github.com/MuhmdRaouf/shipengine
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for ShipEngine
+test_files: []