hoalife 0.1.0

data/lib/hoalife/resources/collection.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# A collection of resources
+# Usually returned by an index endpoint
+class HOALife::Resources::Collection
+  include HOALife::Resources::Requestable
+
+  attr_reader :url
+
+  def initialize(url)
+    @url = url
+    @meta = {}
+    @links = {}
+  end
+
+  # Return all pages
+  def all
+    all_resources = resources
+
+    if @meta['current_page'] < @meta['total_pages']
+      all_resources += self.class.new(@links['next']).all
+    end
+
+    all_resources
+  end
+
+  # Just return the first result
+  def first
+    if resources.is_a?(Array)
+      resources.first
+    else
+      resources
+    end
+  end
+
+  # Just return the last result
+  def last
+    all.last
+  end
+
+  # Add query parameters to the URL
+  def where(params = {})
+    self.class.new add_params_to_url!(params)
+  end
+
+  def order(col, dir = :asc)
+    safe_dir = dir.to_s.downcase == 'desc' ? 'desc' : 'asc'
+    self.class.new add_params_to_url!(order: col, order_dir: safe_dir)
+  end
+
+  def total_pages
+    data
+
+    @meta['total_pages']
+  end
+
+  def current_page
+    data
+
+    @meta['current_page']
+  end
+
+  def total
+    data
+
+    @meta['total']
+  end
+  alias count total
+  alias size total
+
+  def reload
+    @data = nil
+
+    self
+  end
+
+  private
+
+  def request!
+    make_request! do
+      response = HOALife::Client::Get.new(@url)
+
+      @meta  = response.json['meta']
+      @links = response.json['links']
+
+      response
+    end
+  end
+
+  def add_params_to_url!(new_params)
+    uri = URI(@url)
+    exisiting_params = Hash[URI.decode_www_form(uri.query || '')]
+    new_params.each { |k, v| exisiting_params[k.to_s] = v }
+    uri.query = URI.encode_www_form(exisiting_params)
+
+    uri.to_s
+  end
+
+  def data
+    @data ||= request!.json['data']
+  end
+
+  def resources
+    if data.is_a?(Array)
+      # array of resource objects for each instance
+      data.collect { |instance| HOALife::Resource.new(instance) }
+    else
+      # return a single resource
+      HOALife::Resource.new(data)
+    end
+  end
+end

data/lib/hoalife/resources/has_nested_object.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Wrap an attribute in an object
+module HOALife::Resources::HasNestedObject
+  extend HOALife::Concern
+
+  class_methods do
+    attr_reader :has_nested_objects
+
+    # rubocop:disable Naming/PredicateName
+    def has_nested_object(key, class_name)
+      @has_nested_objects ||= {}
+
+      @has_nested_objects[key] = class_name
+
+      add_nested_object_methods!(key, class_name)
+    end
+    # rubocop:enable Naming/PredicateName
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def add_nested_object_methods!(key, class_name)
+      define_method key do
+        raw_value = super()
+
+        begin
+          klass = Object.const_get("HOALife::#{class_name}")
+        rescue NameError
+          raise HOALife::UndefinedResourceError,
+                "HOALife::#{class_name} not defined"
+        end
+
+        if raw_value.is_a?(Array)
+          raw_value.collect { |value| klass.new(value) }
+        elsif raw_value.is_a?(Hash)
+          klass.new(raw_value)
+        else
+          raw_value
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/hoalife/resources/has_nested_resources.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Automatically follow links to related resources
+module HOALife::Resources::HasNestedResources
+  extend HOALife::Concern
+
+  class_methods do
+    attr_reader :has_nested_resources
+
+    # rubocop:disable Naming/PredicateName
+    def has_nested(key)
+      @has_nested_resources ||= []
+
+      @has_nested_resources.push(key)
+
+      add_nested_resources_methods!(key)
+    end
+    # rubocop:enable Naming/PredicateName
+
+    private
+
+    def add_nested_resources_methods!(key)
+      define_method key do
+        raw_value = super()
+        if raw_value.is_a?(Array)
+          raw_value.collect do |value|
+            HOALife::Resources::Collection.new(value['link']).all
+          end.flatten
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/hoalife/resources/persistable.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Persist an object
+module HOALife::Resources::Persistable
+  include HOALife::Resources::Requestable
+  extend HOALife::Concern
+
+  class_methods do
+    def create(attrs = {})
+      new(attrs).tap(&:save)
+    end
+  end
+
+  def save
+    self.errors = nil
+
+    if !persisted?
+      create!
+    else
+      update!
+    end
+
+    errors.nil?
+  end
+
+  def persisted?
+    !id.nil?
+  end
+
+  def update(attrs = {})
+    return false unless persisted?
+
+    attrs.each do |key, value|
+      send("#{key}=", value)
+    end
+
+    save
+  end
+
+  def destroy
+    make_request! do
+      response = HOALife::Client::Delete.new(update_url)
+
+      response.status == 202
+    end
+  end
+
+  private
+
+  def create_url
+    HOALife.api_base + self.class.base_path
+  end
+
+  def update_url
+    HOALife.api_base + self.class.base_path + "/#{id}"
+  end
+
+  def create!
+    make_request! do
+      response = HOALife::Client::Post.new(create_url, to_json)
+
+      assign_updated_data!(response.json)
+    end
+  rescue HOALife::BadRequestError => e
+    assign_errors!(e)
+  end
+
+  def update!
+    make_request! do
+      response = HOALife::Client::Put.new(update_url, to_json)
+
+      assign_updated_data!(response.json)
+    end
+  rescue HOALife::BadRequestError => e
+    assign_errors!(e)
+  end
+
+  def assign_updated_data!(data)
+    @obj = cast_attrs(data.dig('data', 'attributes'))
+
+    data.dig('data', 'attributes').each { |k, v| send("#{k}=", v) }
+  end
+
+  def assign_errors!(err)
+    self.errors = OpenStruct.new(err.details.dig('data', 'attributes'))
+  end
+end

data/lib/hoalife/resources/requestable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Client request convenience methods
+module HOALife::Resources::Requestable
+  def make_request!(&blk)
+    blk.call
+  rescue HOALife::RateLimitError => e
+    raise e unless HOALife.sleep_when_rate_limited
+
+    sleep HOALife.sleep_when_rate_limited.to_f
+    retry
+  end
+end

data/lib/hoalife/upload_url.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::UploadUrl < OpenStruct
+  def url_expiration
+    Time.parse(super)
+  end
+end

data/lib/hoalife/user.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::User < OpenStruct
+end

data/lib/hoalife/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HOALife
+  VERSION = '0.1.0'
+end

data/lib/hoalife/violation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# :nodoc
+class HOALife::Violation < HOALife::Resource
+  include HOALife::Resources::HasNestedObject
+  include HOALife::Resources::Persistable
+
+  self.base_path = '/violations'
+
+  has_nested_object :upload_urls, 'UploadUrl'
+  has_nested_object :inspector, 'User'
+
+  def as_json
+    h = super
+
+    h.dig('data', 'relationships').merge!(
+      'property' => { 'data' => { 'id' => property_id } },
+      'ccr_violation_type' => { 'data' => { 'id' => ccr_violation_type_id } },
+      'inspector' => { 'data' => { 'email' => inspector_email } }
+    )
+
+    h
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: hoalife
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Westendorf
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: Interface for the HOALife.com HTTP API.
+email:
+- daniel@prowestech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hoalife.gemspec
+- lib/hoal_inflector.rb
+- lib/hoalife.rb
+- lib/hoalife/account.rb
+- lib/hoalife/ccr_article.rb
+- lib/hoalife/ccr_violation_type.rb
+- lib/hoalife/client/base.rb
+- lib/hoalife/client/delete.rb
+- lib/hoalife/client/get.rb
+- lib/hoalife/client/post.rb
+- lib/hoalife/client/put.rb
+- lib/hoalife/concern.rb
+- lib/hoalife/error.rb
+- lib/hoalife/escalation.rb
+- lib/hoalife/inspection.rb
+- lib/hoalife/property.rb
+- lib/hoalife/resource.rb
+- lib/hoalife/resources/collection.rb
+- lib/hoalife/resources/has_nested_object.rb
+- lib/hoalife/resources/has_nested_resources.rb
+- lib/hoalife/resources/persistable.rb
+- lib/hoalife/resources/requestable.rb
+- lib/hoalife/upload_url.rb
+- lib/hoalife/user.rb
+- lib/hoalife/version.rb
+- lib/hoalife/violation.rb
+homepage: https://docs.hoalife.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://docs.hoalife.com
+  source_code_uri: https://github.com/hoalife/hoalife-ruby
+  changelog_uri: https://github.com/hoalife/hoalife-ruby/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby API Client for the HOALife.com API
+test_files: []