hoalife 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 898cbe254f04af0df5d1e3edb7d4ef51ccccee6400f7b56ac5b65a1fa0fa16ec
+  data.tar.gz: 281fe3403aa5d32b2018f05afc369d29eb8f246a710d896dac786cec58bb2dff
+SHA512:
+  metadata.gz: d23041cd85f41453214cbef0e954e1ca1de2d3c6942f91deac1708c281e0654ff981851c4ab306c9928de9f04c4954f0096f69f4e4a84f500544838f786913b2
+  data.tar.gz: 455a8251de3cbc64b257ffa28ccc9176adfe330077c0d153794d51dd1410fa22df8a168c5bb039bc2b4f9091095b8c713b47a355c2e4dc4a155e70e55723da8a

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/dev_test/
+.envrc

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Exclude:
+    - 'dev_test/**'
+    - 'lib/hoalife/concern.rb' # copied from rails source
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Metrics/ClassLength:
+  Exclude:
+    - 'test/**/*_test.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'test/**/*_test.rb'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hoalife.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    hoalife (0.1.0)
+      zeitwerk (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    ffi (1.11.1)
+    hashdiff (1.0.0)
+    jaro_winkler (1.5.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    public_suffix (3.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.5)
+    unicode-display_width (1.6.0)
+    webmock (3.6.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  hoalife!
+  listen
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rubocop (~> 0.74)
+  webmock
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Daniel Westendorf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,220 @@
+# HOALife - Ruby API Client
+
+Pragmatic access to the HOALife REST API. [https://docs.hoalife.com](https://docs.hoalife.com).
+
+This library seamlessly handles pagination, CRUD actions, Rate Limiting, and Error handling for you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hoalife'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hoalife
+
+## Usage
+
+### Configuration
+
+Configure the client with your credentials in your code.
+
+```ruby
+HOALife.config do |config|
+  config.api_key                 = 'sk_YOURSUPERSECRETKEY'
+  config.signing_secret          = 'ss_YOURSIGNINGSECRET'
+  config.sleep_when_rate_limited = 10.0 # Optional
+end
+
+# or
+
+HOALife.api_key                 = 'sk_YOURSUPERSECRETKEY'
+HOALife.signing_secret          = 'ss_YOURSIGNINGSECRET'
+HOALife.sleep_when_rate_limited = 10.0 # Optional
+```
+
+Alternatively, you can specify the `api_key`, and `signing_secret` with environmental variables.
+
+```sh
+HOALIFE_API_KEY=sk_YOURSUPERSECRETKEY
+HOALIFE_SIGNING_SECRET=ss_YOURSIGNINGSECRET
+
+echo $HOALIFE_API_KEY # => sk_YOURSUPERSECRETKEY
+echo $HOALIFE_SIGNING_SECRET # => ss_YOURSIGNINGSECRET
+```
+
+### Rate Limits
+
+The HOALife API implements per-API Key rate limiting to prevent API abuse from impacting other customers. See the Rate Limiting section of [https://docs.hoalife.com](https://docs.hoalife.com) for details. This library can handle the rate limit in two different ways.
+
+#### Sleep When Rate Limited (Default)
+
+This method seamlessly handles hitting the rate limit for you by sleeping for a given period then trying the HTTP call when a `429 Rate Limit Exceeded` response is returned by the API. This will make the rate limit transparent to your script, and works best when using the API client in a single threaded, synchronous, fashion.
+
+Set `HOALife#sleep_when_rate_limited` to a `Float` to configure the period that the client will sleep for before retrying the HTTP call.
+
+#### Raise an Error When Rate Limited
+
+If you're accessing the API from multiple machines/threads/processes, you may not want to sleep when the limit is hit, but instead handle the retry logic on your own. In this scenario, a `HOALife::RateLimitError` will be raised.
+
+Set `HOALife#sleep_when_rate_limited` to `nil` to configure the client to raise an error instead of sleeping and retrying the HTTP call.
+
+### Error Handling
+
+This library tries to handle errors for you in a transparent and intuitive way so that you can resolve them and move forward. See `lib/hoalife/errors.rb` for a full list of the possible errors.
+
+#### HTTP Based Errors
+
+Errors caused by bad HTTP calls will provide additional information via the `HTTPError#status`, `HTTPError#headers` and `HTTPError#details` methods.
+
+```ruby
+# An invalid API Key
+begin
+  HOALife.api_key = 'foo'
+  HOALife::Account.create(name: 'foobar')
+rescue HOALife::HTTPError => e
+  puts e.status # => 401
+  puts e.headers # => {"content-type"=>"application/json; charset=utf-8", ... }
+  puts e.details # => {"data"=>{"id"=>"7b06f5e7-a572-4639-bae6-02e41aa367dd", "type"=>"error", "attributes"=>{"id"=>"7b06f5e7-a572-4639-bae6-02e41aa367dd", "title"=>"Invalid API Key", "status"=>401, "detail"=>"Provided API key foo was not valid"}}}
+end
+```
+
+```ruby
+# API key does not have permission for the given action
+begin
+  HOALife::Account.create(name: 'foobar')
+rescue HOALife::HTTPError => e
+  puts e.status # => 403
+  puts e.headers # => {"x-ratelimit-limit"=>"10", ... }
+  puts e.details # => {"data"=>{"id"=>"80143c2b-1b1b-4b33-b31e-751e31da8e5a", "type"=>"error", "attributes"=>{"id"=>"80143c2b-1b1b-4b33-b31e-751e31da8e5a", "title"=>"Permission denied", "status"=>403, "detail"=>"This API key sk_YOURSUPERSECRETKEY does not have access to the requested resource"}}}
+end
+```
+
+## Implemented Resources
+
+Resource | READ | CREATE | UPDATE | DESTROY |
+-------- | ----- |------- | ------ | ------- |
+`HOALife::Account` | true | true | true | true |
+`HOALife::Property` | true | true | true | true |
+`HOALife::CCRArticle` | true | true | true | true |
+`HOALife::CCRViolationType` | true | true | true | true |
+`HOALife::Violation` | true | true | true | true |
+`HOALife::Inspection` | true | false | false | false |
+`HOALife::Escalation` | true | false | false | false |
+
+## Reading Resources
+
+Resources respond to many `ActiveRecord`-like methods like `all`, `count`, `first`, `last`, `total_pages`, `reload`, `where`, and `order`. All Resources respond to the Read methods.
+
+### Examples
+
+```ruby
+# Get all accounts
+accounts = HOALife::Account.all
+
+# Get the first account
+account = HOALife::Account.first
+
+# Total count of the available resources
+count = HOALife::Account.count
+
+# Get the most recently created account
+count = HOALife::Account.order(:created_at, :desc).first
+
+# Get all accounts that match a condition
+HOALife::Account.where(parent_id: 1).all
+
+# Get the first account which matches a condition
+HOALife::Account.where(external_id: 'myInternalId1').first
+
+# Get all properties under a given account, ordered by external ID
+HOALife::Property.where(account_id: 3).order(:external_id, :asc).all
+```
+
+## Creating Resources
+
+Resources supporting creation respond to the `HOALife::Resource.create` class method, and the `HOALife::Resource#save` instance method.
+
+### Examples
+
+```ruby
+# Create an account
+account = HOALife::Account.create(parent_id: 1, name: "foo")
+account.id # => 33
+account.errors # => nil
+account.persisted? # => true
+
+# or
+
+account = HOALife::Account.new(parent_id: 1, name: "foo")
+account.save # => true
+account.errors # => nil
+account.persisted? # => true
+
+# Account which doesn't meet data validation requirements
+account = HOALife::Account.create()
+account.id # => nil
+account.persisted? # => false
+account.errors.detail # => {"parent_id"=>"is invalid"}
+
+# Property which doesn't meet data validation requirements
+property = HOALife::Property.create(account_id: 2)
+property.errors.detail # => {"street_1"=>"can't be blank", "city"=>"can't be blank", "state"=>"can't be blank", "postal_code"=>"can't be blank"}
+```
+
+## Updating Resources
+
+Resources supporting updating respond to the `HOALife::Resource#save` instance method.
+
+### Examples
+
+```ruby
+# Create an account
+account = HOALife::Account.first
+account.update(name: 'bar') # => true
+
+# or
+
+account.name = 'bar'
+account.save # => true
+account.name # => 'bar'
+
+account.name = ''
+account.save # => false
+account.name # => ''
+account.errors.detail # => {"name"=>"can't be blank"}
+```
+
+## Destroying Resources
+
+Resources supporting deletion respond to the `HOALife::Resource#destroy` instance method.
+
+### Examples
+
+```ruby
+# Create an account
+account = HOALife::Account.first
+
+account.destroy # => true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hoalife.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'hoalife'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hoalife.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hoalife/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hoalife'
+  spec.version       = HOALife::VERSION
+  spec.authors       = ['Daniel Westendorf']
+  spec.email         = ['daniel@prowestech.com']
+
+  spec.summary       = 'Ruby API Client for the HOALife.com API'
+  spec.description   = 'Interface for the HOALife.com HTTP API.'
+  spec.homepage      = 'https://docs.hoalife.com'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hoalife/hoalife-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/hoalife/hoalife-ruby/master/CHANGELOG.md'
+
+  # 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
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'zeitwerk', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'listen', '~> 3.1'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.74'
+  spec.add_development_dependency 'webmock', '~> 3.6'
+end

data/lib/hoal_inflector.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Inflector to support the HOAL style of
+# spelling HOALife
+class HOALInflector < Zeitwerk::Inflector
+  def camelize(basename, _abspath)
+    case basename
+    when /(ccr_)(.+)/
+      "CCR#{super(Regexp.last_match(2), nil)}"
+    when 'hoalife'
+      'HOALife'
+    when /Error/
+      'Error'
+    else
+      super
+    end
+  end
+end