artemis_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ebdb821d7dca5b2888ded8eeef552f22486a866
+  data.tar.gz: f18fbf29bed0e7b67fda21717711edf85f253b53
+SHA512:
+  metadata.gz: 4d7baf2ba2584ccd7ce8f53f84fd5e0611b5d31fa70eea2a1f8207c6bf8b614a8325cd6e39bc50530ae2a6eacc207f1f3edb92f8112a6024b99a572d750e7761
+  data.tar.gz: b7f58a2902751e5e86319e489fb6aece341e139c02cb441252a40b0181d37dc86d2eaf5e92c5e0c0de039a626dc8e3fad82b31e05ad909767e88af73ae98b8fa

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jhampton@agrilyst.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in artemis_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    artemis_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.4.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jwt (2.2.1)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    public_suffix (3.1.1)
+    rack (2.0.7)
+    rake (10.5.0)
+    safe_yaml (1.0.5)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    webmock (3.6.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  artemis_api!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  oauth2
+  rake (~> 10.0)
+  webmock
+
+BUNDLED WITH
+   1.17.2

data/History.txt

@@ -0,0 +1,8 @@
+# coding: UTF-8
+
+=== 0.1.0 / 2019-10-03
+
+* Initial public release of the Artemis API wrapper
+
+Includes initial support for the following Artemis classes:
+User, Facility, Organization, Batch, Zone, Completion, Harvest, Discard, HarvestUnit, SeedingUnit

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jamie Hampton
+
+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,187 @@
+# ArtemisApi
+
+This is a simple API wrapper for the [Artemis](https://artemisag.com/) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'artemis_api', :git => 'https://github.com/artemis-ag/artemis_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install artemis_api
+
+## Usage
+
+In order to use this gem, you will need to be set up as a developer in the Artemis Portal. If you're not, please contact Artemis CS in order to get that settled.
+
+Once you have developer access, go to Settings and choose "OAuth 2.0 Applications" at the bottom of the sidebar to set up an application by entering the name and redirect URI you wish to use. You will then be provided with an application ID and a secret ID, which you will need in order to authenticate with Artemis.
+
+(Please note that this gem doesn't currently handle OAuth. You will need to do that on your own in order to generate your access token and refresh token. We recommend using the [OAuth2 gem](https://github.com/oauth-xx/oauth2). You'll also need to pass in the `expires_at` for when your token will exipire.)
+
+Once you have all this info, the first step to actually using this gem is to instantiate an instance of `ArtemisApi::Client` - which requires an access token, a refresh token,
+
+```ruby
+options = {app_id: 'your_artemis_application_id',
+           app_secret: 'your_artemis_secret_id',
+           base_uri: 'https://portal.artemisag.com'}
+
+client = ArtemisApi::Client.new(access_token: 'your_access_token',
+                                refresh_token: 'your_refresh_token',
+                                expires_at: token_expires_at,
+                                options: options)
+```
+
+Alternatively, instead of passing in options, you can set those values as ENV variables called `ENV['ARTEMIS_OAUTH_APP_ID']`, `ENV['ARTEMIS_OAUTH_APP_SECRET']` and `ENV['ARTEMIS_BASE_URI']`
+
+They will be automatically detected and then you don't have to pass in any options:
+```ruby
+client = ArtemisApi::Client.new(access_token: 'your_access_token',
+                                refresh_token: 'your_refresh_token',
+                                expires_at: token_expires_at)
+```
+
+Once you have a client instance, you can use it to request information from Artemis.
+
+To get user information about the Artemis User that is associated with your application ID:
+```ruby
+client.current_user
+```
+Or alternatively, you can make the call directly to the User class:
+
+```ruby
+ArtemisApi::User.get_current(client: client)
+```
+
+(Please note that we use named parameters in most of our function calls.)
+
+You can use either method to get a list of all Artemis Organizations or Facilities that you have access to:
+```ruby
+client.organizations
+client.facilities
+
+ArtemisApi::Organization.find_all(client: client)
+ArtemisApi::Facility.find_all(client: client)
+```
+
+To get facility information about a single Artemis Organization or Facility that you have access to, by its Artemis ID:
+```ruby
+client.organization(1)
+client.facility(2)
+
+ArtemisApi::Organization.find(id: 1, client: client)
+ArtemisApi::Facility.find(id: 2, client: client)
+```
+
+Other models are scoped by facility, so you have to include the Facility id in the call. (You can also get information about other Artemis Users besides your own account this way.)
+
+To get all Users associated with the Facility with an ID of 2, again there are two methods. You can call directly to the User class, or you can query through a facility.
+```ruby
+client.facility(2).users
+
+ArtemisApi::User.find_all(facility_id: 2, client: client)
+```
+
+To get a single User, with id 12, which must also be associated with Facility 2:
+```ruby
+client.facility(2).user(12)
+
+ArtemisApi::User.find(id: 12, facility_id: 2, client: client)
+```
+
+You can get info about Batches, Zones, SeedingUnits, HarvestUnits and Subscriptions in the same manner. Here are a couple examples, but the syntax is all the same.
+```ruby
+client.facility(2).batches
+client.facility(2).batch(22)
+
+ArtemisApi::Batch.find_all(facility_id: 2, client: client)
+ArtemisApi::Batch.find(id: 22, facility_id: 2, client: client)
+
+client.facility(2).seeding_units
+client.facility(2).seeding_unit(4)
+
+ArtemisApi::SeedingUnit.find_all(facility_id: 2, client: client)
+ArtemisApi::SeedingUnit.find(id: 4, facility_id: 2, client: client)
+```
+
+Completions, Harvests and Discards can be queried through a Batch object in a similar way. Again, you can also call directly to the class. Note that in the above examples, querying through facility or the class will give you the exact same results: that isn't true in this case. Querying through the batch will return only objects associated with that batch, while doing a `find_all` on the class will give you all objects associated with the entire facility.
+```ruby
+client.facility(2).batch(22).harvests
+client.facility(2).batch(22).discards
+client.facility(2).batch(22).completions
+
+client.facility(2).batch(22).harvest(47)
+
+ArtemisApi::Harvest.find_all(facility_id: 2, client: client)
+ArtemisApi::Harvest.find(id: 47, facility_id: 2, client: client)
+```
+
+Additionally, Items are scoped by both Facility and Batch, so both are required even if you call directly to the Item class. There is also an optional `seeding_unit_id` param if you query through a batch.
+```ruby
+client.facility(2).batch(22).items
+client.facility(2).batch(22).items(seeding_unit_id: 17)
+
+ArtemisApi::Item.find_all(facility_id: 2, batch_id: 22, client: client)
+```
+
+Once you have queried info about a certain object, it will be stored in a hash called `objects` that exists on your active `client` object. Then, if you have to query the same object again, it can be pulled from that hash instead of doing another actual call to the API, to speed up performance. If you need to actually hit the API again for the most updated information, you can force the query like this:
+```ruby
+facility = ArtemisApi::Facility.find(id: 2, client: client, force: true)
+```
+
+Additionally, you can optionally include other models in your call that have a relationship with the model you're querying. They will then be included in the payload and added into the objects hash for your `client` for easier querying in the future.
+
+```ruby
+ArtemisApi::Facility.find(id: 2, client: client, include: "users")
+ArtemisApi::Batch.find(id: 22, facility_id: 2, client: client, include: "completions")
+```
+
+We also support filtering on several models: Batch, Completion, Discard, Harvest, Zone, Item. It is another optional param and it expects a hash. Here's what that should look like.
+
+```ruby
+ArtemisApi::Batch.find_all(facility_id: 2, client: client, filters: {view: 'all_batches', search: 'genovese basil'})
+ArtemisApi::Batch.find_all(facility_id: 2, client: client, filters: {ids: [2, 4, 6, 11]})
+ArtemisApi::Completion.find_all(facility_id: 2, client: client, filters: {crop_batch_ids: [5]})
+ArtemisApi::Harvest.find_all(facility_id: 2, client: client, filters: {crop_batch_ids: [5, 7]})
+ArtemisApi::Discard.find_all(facility_id: 2, client: client, filters: {crop_batch_ids: [6, 7, 9]})
+ArtemisApi::Zone.find_all(facility_id: 2, client: client, filters: {seeding_unit_id: 3})
+ArtemisApi::Item.find_all(facility_id: 2, batch_id: 22, client: client, filters: {seeding_unit_id: 8})
+```
+
+Note that when you filter by ids or crop_batch_ids, you must pass in an array even if it only has one element.
+
+The Artemis API is currently mainly read only, but we do support the creation of Subscriptions. These are used to set up webhooks that will make a callback to you whenever a Completion or Batch gets created or updated in the given facility. They require a `subject`, which can currently be either `completions` or `batches`, and a `destination`, which is the url that you want the callback to hit. There are two ways to make that call:
+
+```ruby
+ArtemisApi::Subscription.create(facility_id: 2,
+                                subject: 'completions',
+                                destination: 'https://test-app-url.artemisag.io/v1/webhook',
+                                client: client)
+
+facility.create_subscription(subject: 'completions', destination: 'https://test-app-url.artemisag.io/v1/webhook')
+```
+
+## 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/artemis-ag/artemis_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ArtemisApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/artemis-ag/artemis_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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/artemis_api.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "artemis_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "artemis_api"
+  spec.version       = ArtemisApi::VERSION
+  spec.authors       = ["Jamey Hampton"]
+  spec.email         = ["jhampton@artemisag.com"]
+
+  spec.summary       = %q{An API wrapper for the ArtemisAg API}
+  spec.homepage      = "https://github.com/artemis-ag/artemis_api/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "oauth2"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "activesupport"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "artemis_api"
+
+# 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/lib/artemis_api.rb

@@ -0,0 +1,19 @@
+require 'artemis_api/client'
+require 'artemis_api/model'
+require 'artemis_api/facility'
+require 'artemis_api/user'
+require 'artemis_api/version'
+require 'artemis_api/zone'
+require 'artemis_api/organization'
+require 'artemis_api/batch'
+require 'artemis_api/completion'
+require 'artemis_api/discard'
+require 'artemis_api/harvest'
+require 'artemis_api/seeding_unit'
+require 'artemis_api/harvest_unit'
+require 'artemis_api/item'
+require 'artemis_api/subscription'
+
+module ArtemisApi
+  # Your code goes here...
+end

data/lib/artemis_api/batch.rb

@@ -0,0 +1,66 @@
+module ArtemisApi
+  class Batch < ArtemisApi::Model
+    json_type 'batches'
+    related_to_one :zone
+    related_to_one :seeding_unit
+    related_to_one :harvest_unit
+
+    def self.find(id:, client:, facility_id:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(client:, facility_id:, include: nil, filters: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include, filters: filters)
+    end
+
+    def completions(include: nil)
+      ArtemisApi::Completion.find_all(facility_id: facility_id,
+                                      client: client,
+                                      include: include,
+                                      filters: {crop_batch_ids: [id]})
+    end
+
+    def completion(completion_id, include: nil)
+      ArtemisApi::Completion.find(id: completion_id,
+                                  facility_id: facility_id,
+                                  client: client,
+                                  include: include)
+    end
+
+    def discards(include: nil)
+      ArtemisApi::Discard.find_all(facility_id: facility_id,
+                                   client: client,
+                                   include: include,
+                                   filters: {crop_batch_ids: [id]})
+    end
+
+    def discard(discard_id, include: nil)
+      ArtemisApi::Discard.find(id: discard_id,
+                               facility_id: facility_id,
+                               client: client,
+                               include: include)
+    end
+
+    def harvests(include: nil)
+      ArtemisApi::Harvest.find_all(facility_id: facility_id,
+                                   client: client,
+                                   include: include,
+                                   filters: {crop_batch_ids: [id]})
+    end
+
+    def harvest(harvest_id, include: nil)
+      ArtemisApi::Harvest.find(id: harvest_id,
+                               facility_id: facility_id,
+                               client: client,
+                               include: include)
+    end
+
+    def items(seeding_unit_id: nil, include: nil)
+      ArtemisApi::Item.find_all(facility_id: facility_id,
+                                batch_id: id,
+                                client: client,
+                                include: include,
+                                filters: {seeding_unit_id: seeding_unit_id})
+    end
+  end
+end

data/lib/artemis_api/client.rb

@@ -0,0 +1,142 @@
+module ArtemisApi
+  class Client
+    require 'oauth2'
+    attr_reader :options, :objects, :access_token, :refresh_token, :oauth_client,
+                :oauth_token, :expires_at
+
+    def initialize(access_token:, refresh_token:, expires_at:, options: {})
+      options[:app_id] ||= ENV['ARTEMIS_OAUTH_APP_ID']
+      options[:app_secret] ||= ENV['ARTEMIS_OAUTH_APP_SECRET']
+      options[:base_uri] ||= ENV['ARTEMIS_BASE_URI']
+      @options = options
+      @access_token = access_token
+      @refresh_token = refresh_token
+      @expires_at = expires_at
+
+      @oauth_client = OAuth2::Client.new(@options[:app_id], @options[:app_secret], site: @options[:base_uri])
+      @oauth_token = OAuth2::AccessToken.from_hash(
+                      oauth_client,
+                      {access_token: @access_token,
+                       refresh_token: @refresh_token,
+                       expires_at: @expires_at})
+      @objects = {}
+    end
+
+    def find_one(type, id, facility_id: nil, include: nil, force: false)
+      obj = get_record(type, id)
+      if !obj || force
+        refresh if @oauth_token.expired?
+
+        url = if facility_id
+                "#{@options[:base_uri]}/api/v3/facilities/#{facility_id}/#{type}/#{id}"
+              else
+                "#{@options[:base_uri]}/api/v3/#{type}/#{id}"
+              end
+        url = "#{url}?include=#{include}" if include
+
+        response = @oauth_token.get(url)
+        obj = process_response(response, type) if response.status == 200
+      end
+      obj
+    end
+
+    def find_all(type, facility_id: nil, batch_id: nil, include: nil, filters: nil)
+      records = []
+      refresh if @oauth_token.expired?
+
+      url = if facility_id && batch_id
+              "#{@options[:base_uri]}/api/v3/facilities/#{facility_id}/batches/#{batch_id}/#{type}"
+            elsif facility_id && batch_id.nil?
+              "#{@options[:base_uri]}/api/v3/facilities/#{facility_id}/#{type}"
+            else
+              "#{@options[:base_uri]}/api/v3/#{type}"
+            end
+
+      url = "#{url}?include=#{include}" if include
+      if filters
+        formatted_filters = format_filters(filters)
+        url = (include) ? "#{url}&#{formatted_filters}" : "#{url}?#{formatted_filters}"
+      end
+
+      response = @oauth_token.get(url)
+      if response.status == 200
+        records = process_array(response, type, records)
+      end
+      records
+    end
+
+    def store_record(type, id, data)
+      @objects[type] ||= {}
+      @objects[type][id.to_i] = ArtemisApi::Model.instance_for(type, data, self)
+    end
+
+    def get_record(type, id)
+      @objects[type]&.[](id.to_i)
+    end
+
+    def refresh
+      @oauth_token = @oauth_token.refresh!
+    end
+
+    def facilities(include: nil)
+      find_all('facilities', include: include)
+    end
+
+    def facility(id, include: nil, force: false)
+      find_one('facilities', id, include: include, force: force)
+    end
+
+    def organizations(include: nil)
+      find_all('organizations', include: include)
+    end
+
+    def organization(id, include: nil, force: false)
+      find_one('organizations', id, include: include, force: force)
+    end
+
+    def current_user(include: nil)
+      ArtemisApi::User.get_current(client: self, include: include)
+    end
+
+    def process_response(response, type)
+      json = JSON.parse(response.body)
+      obj = store_record(type, json['data']['id'].to_i, json['data'])
+      process_included_objects(json['included']) if json['included']
+
+      obj
+    end
+
+    private
+
+    def process_array(response, type, records)
+      json = JSON.parse(response.body)
+      json['data'].each do |obj|
+        record = store_record(type, obj['id'], obj)
+        records << record
+      end
+      process_included_objects(json['included']) if json['included']
+
+      records
+    end
+
+    def process_included_objects(included_array)
+      included_array.each do |included_obj|
+        store_record(included_obj['type'], included_obj['id'], included_obj)
+      end
+    end
+
+    def format_filters(filter_hash)
+      filter_string = ''
+      filter_hash.each do |k, v|
+        if v.kind_of?(Array)
+          v.each do |item|
+            filter_string += "filter[#{k}][]=#{item}&"
+          end
+        else
+          filter_string += "filter[#{k}]=#{v}&"
+        end
+      end
+      filter_string
+    end
+  end
+end

data/lib/artemis_api/completion.rb

@@ -0,0 +1,13 @@
+module ArtemisApi
+  class Completion < ArtemisApi::Model
+    json_type 'completions'
+
+    def self.find(id:, facility_id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(facility_id:, client:, include: nil, filters: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include, filters: filters)
+    end
+  end
+end

data/lib/artemis_api/discard.rb

@@ -0,0 +1,13 @@
+module ArtemisApi
+  class Discard < ArtemisApi::Model
+    json_type 'discards'
+
+    def self.find(id:, facility_id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(facility_id:, client:, include: nil, filters: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include, filters: filters)
+    end
+  end
+end

data/lib/artemis_api/facility.rb

@@ -0,0 +1,65 @@
+module ArtemisApi
+  class Facility < ArtemisApi::Model
+    json_type 'facilities'
+
+    def self.find(id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, include: include, force: force)
+    end
+
+    def self.find_all(client:, include: nil)
+      client.find_all(self.json_type, include: include)
+    end
+
+    def zones(include: nil)
+      ArtemisApi::Zone.find_all(facility_id: id, client: client, include: include)
+    end
+
+    def zone(zone_id, include: nil)
+      ArtemisApi::Zone.find(id: zone_id, facility_id: id, client: client, include: include)
+    end
+
+    def batches(include: nil)
+      ArtemisApi::Batch.find_all(facility_id: id, client: client, include: include)
+    end
+
+    def batch(batch_id, include: nil)
+      ArtemisApi::Batch.find(id: batch_id, facility_id: id, client: client, include: include)
+    end
+
+    def users(include: nil)
+      ArtemisApi::User.find_all(facility_id: id, client: client, include: include)
+    end
+
+    def user(user_id, include: nil)
+      ArtemisApi::User.find(id: user_id, facility_id: id, client: client, include: include)
+    end
+
+    def seeding_units(include: nil)
+      ArtemisApi::SeedingUnit.find_all(facility_id: id, client: client, include: include)
+    end
+
+    def seeding_unit(unit_id, include: nil)
+      ArtemisApi::SeedingUnit.find(id: unit_id, facility_id: id, client: client, include: include)
+    end
+
+    def harvest_units(include: nil)
+      ArtemisApi::HarvestUnit.find_all(facility_id: id, client: client, include: include)
+    end
+
+    def harvest_unit(unit_id, include: nil)
+      ArtemisApi::HarvestUnit.find(id: unit_id, facility_id: id, client: client, include: include)
+    end
+
+    def subscriptions
+      ArtemisApi::Subscription.find_all(facility_id: id, client: client)
+    end
+
+    def subscription(subscription_id)
+      ArtemisApi::Subscription.find(id: subscription_id, facility_id: id, client: client)
+    end
+
+    def create_subscription(subject:, destination:)
+      ArtemisApi::Subscription.create(facility_id: id, subject: subject, destination: destination, client: client)
+    end
+  end
+end

data/lib/artemis_api/harvest.rb

@@ -0,0 +1,13 @@
+module ArtemisApi
+  class Harvest < ArtemisApi::Model
+    json_type 'harvests'
+
+    def self.find(id:, facility_id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(facility_id:, client:, include: nil, filters: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include, filters: filters)
+    end
+  end
+end

data/lib/artemis_api/harvest_unit.rb

@@ -0,0 +1,13 @@
+module ArtemisApi
+  class HarvestUnit < ArtemisApi::Model
+    json_type 'harvest_units'
+
+    def self.find(id:, facility_id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(facility_id:, client:, include: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include)
+    end
+  end
+end

data/lib/artemis_api/item.rb

@@ -0,0 +1,9 @@
+module ArtemisApi
+  class Item < ArtemisApi::Model
+    json_type 'items'
+
+    def self.find_all(facility_id:, batch_id:, client:, include: nil, filters: nil)
+      client.find_all(self.json_type, facility_id: facility_id, batch_id: batch_id, include: include, filters: filters)
+    end
+  end
+end

data/lib/artemis_api/model.rb

@@ -0,0 +1,42 @@
+module ArtemisApi
+  class Model
+    attr_reader :client, :id, :attributes, :relationships
+
+    def self.related_to_one(name)
+      self.send(:define_method, name.to_sym) do
+        relationship = relationships[name.to_s]['data']
+        @client.find_one(relationship['type'], relationship['id'])
+      end
+    end
+
+    def self.related_to_many(name)
+      self.send(:define_method, name.to_sym) do
+        @client.find_all(self.relationships[name.to_s]['data']['type'])
+      end
+    end
+
+    def self.json_type(type = nil)
+      if type
+        @json_type = type
+        @@registered_classes ||= {}
+        @@registered_classes[type] = self
+      end
+      @json_type
+    end
+
+    def self.instance_for(type, data, client)
+      @@registered_classes[type]&.new(client, data)
+    end
+
+    def method_missing(name)
+      attributes[name.to_s]
+    end
+
+    def initialize(client, data)
+      @client = client
+      @id = data['id'].to_i
+      @attributes = data['attributes']
+      @relationships = data['relationships']
+    end
+  end
+end

data/lib/artemis_api/organization.rb

@@ -0,0 +1,13 @@
+module ArtemisApi
+  class Organization < ArtemisApi::Model
+    json_type 'organizations'
+
+    def self.find(id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, include: include, force: force)
+    end
+
+    def self.find_all(client:, include: nil)
+      client.find_all(self.json_type, include: include)
+    end
+  end
+end

data/lib/artemis_api/seeding_unit.rb

@@ -0,0 +1,13 @@
+module ArtemisApi
+  class SeedingUnit < ArtemisApi::Model
+    json_type 'seeding_units'
+
+    def self.find(id:, facility_id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(facility_id:, client:, include: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include)
+    end
+  end
+end

data/lib/artemis_api/subscription.rb

@@ -0,0 +1,24 @@
+module ArtemisApi
+  class Subscription < ArtemisApi::Model
+    json_type 'subscriptions'
+
+    def self.find(id:, facility_id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(facility_id:, client:, include: nil, filters: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include, filters: filters)
+    end
+
+    def self.create(facility_id:, subject:, destination:, client:)
+      client.oauth_token.refresh! if client.oauth_token.expired?
+
+      url = "#{client.options[:base_uri]}/api/v3/facilities/#{facility_id}/subscriptions"
+      params = { body: { subscription: { subject: subject, destination: destination } } }
+
+      response = client.oauth_token.post(url, params)
+
+      response.status == 200 ? client.process_response(response, 'subscriptions') : false
+    end
+  end
+end

data/lib/artemis_api/user.rb

@@ -0,0 +1,27 @@
+module ArtemisApi
+  class User < ArtemisApi::Model
+    json_type 'users'
+    related_to_many :facilities
+
+    def self.get_current(client:, include: nil)
+      self.json_type
+      client.refresh if client.oauth_token.expired?
+      url = "#{client.options[:base_uri]}/api/v3/user"
+      url = "#{url}?include=#{include}" if include
+      response = client.oauth_token.get(url)
+      if response.status == 200
+        json = JSON.parse(response.body)
+        obj = client.store_record('users', json['data']['id'], json['data'])
+      end
+      obj
+    end
+
+    def self.find(id:, facility_id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(facility_id:, client:, include: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include)
+    end
+  end
+end

data/lib/artemis_api/version.rb

@@ -0,0 +1,3 @@
+module ArtemisApi
+  VERSION = "0.1.0"
+end

data/lib/artemis_api/zone.rb

@@ -0,0 +1,13 @@
+module ArtemisApi
+  class Zone < ArtemisApi::Model
+    json_type 'zones'
+
+    def self.find(id:, facility_id:, client:, include: nil, force: false)
+      client.find_one(self.json_type, id, facility_id: facility_id, include: include, force: force)
+    end
+
+    def self.find_all(facility_id:, client:, include: nil, filters: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include, filters: filters)
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: artemis_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamey Hampton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jhampton@artemisag.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- History.txt
+- LICENSE.txt
+- README.md
+- Rakefile
+- artemis_api.gemspec
+- bin/console
+- bin/setup
+- lib/artemis_api.rb
+- lib/artemis_api/batch.rb
+- lib/artemis_api/client.rb
+- lib/artemis_api/completion.rb
+- lib/artemis_api/discard.rb
+- lib/artemis_api/facility.rb
+- lib/artemis_api/harvest.rb
+- lib/artemis_api/harvest_unit.rb
+- lib/artemis_api/item.rb
+- lib/artemis_api/model.rb
+- lib/artemis_api/organization.rb
+- lib/artemis_api/seeding_unit.rb
+- lib/artemis_api/subscription.rb
+- lib/artemis_api/user.rb
+- lib/artemis_api/version.rb
+- lib/artemis_api/zone.rb
+homepage: https://github.com/artemis-ag/artemis_api/
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: An API wrapper for the ArtemisAg API
+test_files: []