hoalife 0.1.0

data/lib/hoalife.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'hoal_inflector'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector = HOALInflector.new
+tests = "#{__dir__}/**/*_test.rb"
+loader.ignore(tests)
+# loader.log!
+
+if ENV['DEV']
+  require 'listen'
+
+  loader.enable_reloading
+  Listen.to('lib') do
+    loader.reload
+  end.start
+end
+
+loader.setup
+
+require 'hoalife/error'
+
+# :nodoc
+module HOALife
+  @api_base                = ENV.fetch('HOALIFE_API_BASE', 'https://api.hoalife.com/api')
+  @api_version             = ENV.fetch('HOALIFE_API_VERSION', '1').to_i
+  @api_key                 = ENV['HOALIFE_API_KEY']
+  @signing_secret          = ENV['HOALIFE_SIGNING_SECRET']
+  @sleep_when_rate_limited = 10.0
+
+  class << self
+    attr_accessor :api_key, :signing_secret, :api_base, :api_version,
+                  :sleep_when_rate_limited
+
+    # Support configuring with a block
+    # HOALife.config do |config|
+    #  config.api_key = "foo"
+    # end
+    # HOALife.api_key
+    #   => "foo"
+    def config
+      yield self
+    end
+  end
+end

data/lib/hoalife/account.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::Account < HOALife::Resource
+  include HOALife::Resources::Persistable
+
+  self.base_path = '/accounts'
+
+  def as_json
+    h = super
+
+    h.dig('data', 'relationships').merge!(
+      'parent' => { 'data' => { 'id' => parent_id } }
+    )
+
+    h
+  end
+end

data/lib/hoalife/ccr_article.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::CCRArticle < HOALife::Resource
+  include HOALife::Resources::Persistable
+
+  self.base_path = '/ccr_articles'
+
+  def as_json
+    h = super
+
+    h.dig('data', 'relationships').merge!(
+      'account' => { 'data' => { 'id' => account_id } }
+    )
+
+    h
+  end
+end

data/lib/hoalife/ccr_violation_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::CCRViolationType < HOALife::Resource
+  include HOALife::Resources::Persistable
+
+  self.base_path = '/ccr_violation_types'
+
+  def as_json
+    h = super
+
+    h.dig('data', 'relationships').merge!(
+      'ccr_article' => { 'data' => { 'id' => ccr_article_id } }
+    )
+
+    h
+  end
+end

data/lib/hoalife/client/base.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'openssl'
+require 'json'
+
+# Base class for all HTTP requests
+# Handles the implementation specific code of the API
+class HOALife::Client::Base
+  def initialize(url, body = nil)
+    @url  = url
+    @body = body
+  end
+
+  def status
+    @status ||= response.code.to_i
+  end
+
+  def json
+    @json ||= JSON.parse(response.body)
+  end
+
+  def response
+    @response ||= validate_response!
+  end
+
+  private
+
+  def request!
+    raise 'Not implemented'
+  end
+
+  def uri
+    @uri ||= URI(@url)
+  end
+
+  def request_headers
+    {
+      'Authorization' => authorization_header,
+      'ACCEPT' => api_version,
+      'Content-Type' => 'application/vnd.api+json'
+    }
+  end
+
+  def validate_response!
+    response = request!
+
+    verify_successful_response!(response)
+
+    verify_signature!(response) unless HOALife.signing_secret.nil?
+
+    response
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def verify_successful_response!(resp)
+    headers = resp.each_header.to_h
+    body    = resp.body
+    code    = resp.code.to_i
+
+    case code
+    when 400
+      raise HOALife::BadRequestError.new(code, headers, body)
+    when 401..403
+      auth_error(headers, body, code)
+    when 404..429
+      http_error(headers, body, code)
+    when 400..600
+      raise HOALife::HTTPError.new(code, headers, generic_error(resp))
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def auth_error(headers, body, code)
+    case code
+    when 401
+      raise HOALife::UnauthorizedError.new(code, headers, body)
+    when 403
+      raise HOALife::ForbiddenError.new(code, headers, body)
+    end
+  end
+
+  def http_error(headers, body, code)
+    case code
+    when 404
+      raise HOALife::NotFoundError.new(code, headers, body)
+    when 429
+      raise HOALife::RateLimitError.new(code, headers, body)
+    end
+  end
+
+  def verify_signature!(resp)
+    digest    = OpenSSL::Digest.new('sha256')
+    signature = OpenSSL::HMAC.hexdigest(
+      digest, HOALife.signing_secret, resp.body
+    )
+
+    raise HOALife::SigningMissmatchError if signature != resp['X-Signature']
+  end
+
+  def api_version
+    return nil if HOALife.api_version.nil?
+
+    "version=#{HOALife.api_version}"
+  end
+
+  def authorization_header
+    raise HOALife::Error, 'No API Key specified' if HOALife.api_key.nil?
+
+    "Token #{HOALife.api_key}"
+  end
+
+  def generic_error(resp)
+    JSON.parse(resp.body)
+  rescue JSON::ParserError
+    { 'data' => {
+      'id' => resp['X-Request-Id'], 'type' => 'error',
+      'attributes' => {
+        'id' => resp['X-Request-Id'], 'title' => 'HTTP Error',
+        'status' => resp.code.to_i, 'detail' => resp.body
+      }
+    } }
+  end
+end

data/lib/hoalife/client/delete.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# HTTP DELETE requests
+class HOALife::Client::Delete < HOALife::Client::Base
+  private
+
+  def request!
+    Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+      req = Net::HTTP::Delete.new(uri, request_headers)
+
+      http.request(req)
+    end
+  end
+end

data/lib/hoalife/client/get.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# HTTP Get requests
+class HOALife::Client::Get < HOALife::Client::Base
+  private
+
+  def request!
+    Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+      req = Net::HTTP::Get.new(uri, request_headers)
+
+      http.request(req)
+    end
+  end
+end

data/lib/hoalife/client/post.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# HTTP POST requests
+class HOALife::Client::Post < HOALife::Client::Base
+  private
+
+  def request!
+    Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+      req = Net::HTTP::Post.new(uri, request_headers)
+
+      req.body = @body
+
+      http.request(req)
+    end
+  end
+end

data/lib/hoalife/client/put.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# HTTP PUT requests
+class HOALife::Client::Put < HOALife::Client::Base
+  private
+
+  def request!
+    Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+      req = Net::HTTP::Put.new(uri, request_headers)
+
+      req.body = @body
+
+      http.request(req)
+    end
+  end
+end

data/lib/hoalife/concern.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Rails ActiveSupport::Concern
+# https://github.com/rails/rails/blob/66cabeda2c46c582d19738e1318be8d59584cc5b/activesupport/lib/active_support/concern.rb#L163
+module HOALife::Concern
+  class MultipleIncludedBlocks < StandardError #:nodoc:
+    def initialize
+      super "Cannot define multiple 'included' blocks for a Concern"
+    end
+  end
+
+  def self.extended(base) #:nodoc:
+    base.instance_variable_set(:@_dependencies, [])
+  end
+
+  def append_features(base) #:nodoc:
+    if base.instance_variable_defined?(:@_dependencies)
+      base.instance_variable_get(:@_dependencies) << self
+      false
+    else
+      return false if base < self
+
+      @_dependencies.each { |dep| base.include(dep) }
+      super
+      base.extend const_get(:ClassMethods) if const_defined?(:ClassMethods)
+      base.class_eval(&@_included_block) if instance_variable_defined?(:@_included_block)
+    end
+  end
+
+  def included(base = nil, &block)
+    if base.nil?
+      if instance_variable_defined?(:@_included_block)
+        if @_included_block.source_location != block.source_location
+          raise MultipleIncludedBlocks
+        end
+      else
+        @_included_block = block
+      end
+    else
+      super
+    end
+  end
+
+  def class_methods(&class_methods_module_definition)
+    mod = const_defined?(:ClassMethods, false) ?
+      const_get(:ClassMethods) :
+      const_set(:ClassMethods, Module.new)
+
+    mod.module_eval(&class_methods_module_definition)
+  end
+end

data/lib/hoalife/error.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module HOALife
+  class Error < StandardError; end
+
+  # HTTP Errors
+  class HTTPError < Error
+    attr_reader :status, :headers, :details
+
+    def initialize(status, headers, details)
+      @status  = status
+      @headers = headers
+
+      begin
+        @details = JSON.parse(details)
+      rescue JSON::ParserError, TypeError
+        @details = details
+      end
+
+      super(status)
+    end
+  end
+
+  class BadRequestError < HTTPError; end
+  class UnauthorizedError < HTTPError; end
+  class ForbiddenError < HTTPError; end
+  class NotFoundError < HTTPError; end
+  class RateLimitError < HTTPError; end
+
+  class SigningMissmatchError < Error; end
+
+  class UndefinedResourceError < Error; end
+end

data/lib/hoalife/escalation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::Escalation < HOALife::Resource
+  include HOALife::Resources::HasNestedResources
+
+  self.base_path = '/escalations'
+
+  has_nested_resources :violations
+end

data/lib/hoalife/inspection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::Inspection < HOALife::Resource
+  self.base_path = '/inspections'
+end

data/lib/hoalife/property.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::Property < HOALife::Resource
+  include HOALife::Resources::Persistable
+
+  self.base_path = '/properties'
+
+  def as_json
+    h = super
+
+    h.dig('data', 'relationships').merge!(
+      'account' => { 'data' => { 'id' => account_id } }
+    )
+
+    h
+  end
+end

data/lib/hoalife/resource.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'json'
+require 'time'
+require 'forwardable'
+
+# :nodoc
+class HOALife::Resource < OpenStruct
+  class << self
+    extend Forwardable
+
+    attr_accessor :base_path
+    def_delegators :resource_collection, :all, :first, :last, :where, :order,
+                   :total_pages, :current_page, :total, :count, :size, :reload
+
+    def new(obj = {}, relationships = {})
+      return super(obj, relationships) unless obj['type']
+
+      camelized = HOALInflector.new.camelize(obj['type'], nil)
+
+      begin
+        klass = Object.const_get("HOALife::#{camelized}")
+      rescue NameError
+        raise HOALife::UndefinedResourceError,
+              "HOALife::#{camelized} is not defined"
+      end
+
+      klass.new(obj['attributes'], obj['relationships'])
+    end
+
+    def resource_collection
+      @resource_collection ||= HOALife::Resources::Collection.new(
+        HOALife.api_base + base_path
+      )
+    end
+  end
+
+  def initialize(obj = {}, _relationships = {})
+    @obj = cast_attrs(obj)
+
+    super(obj)
+  end
+
+  def as_json
+    h = {
+      'data' => {
+        'attributes' => {},
+        'relationships' => {}
+      }
+    }
+
+    each_pair do |k, _v|
+      h['data']['attributes'][k] = send(k)
+    end
+
+    h
+  end
+
+  def to_json(*_args)
+    JSON.generate as_json
+  end
+
+  private
+
+  # rubocop:disable Style/RescueModifier
+  def cast_attrs(obj)
+    obj.each do |k, v|
+      next unless k.match?(/_at$/)
+
+      time = Time.parse(v) rescue nil
+      obj[k] = time if time
+    end
+  end
+  # rubocop:enable Style/RescueModifier
+end