artemis_api 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ddb2f3f02a23e8af40bb40ac71a3ce9a5a6c37e
-  data.tar.gz: 1e63ef8698d8bed206674ff165a82f7fe404a64d
+SHA256:
+  metadata.gz: d26e2f48257f9de7ae7ce3d4b23ea245fdc7d3408a1467bd09b279275240523d
+  data.tar.gz: 673cd71c200ec4f0bdf793b70df3e5075b16a0b37e1ad8f3d008ba3d6deed0a3
 SHA512:
-  metadata.gz: a50bcb4e50699bd837c933bbea113b33454ec61a00233c6ae5e204bf7a5f4cbd00cb4d1225537da8df8d65a382d1704c73fb9ac4571763f1c9e8314a4b29d7d1
-  data.tar.gz: 3a1d56165f91ac90ed852f39e5e355efc946e18d8f22ce8a1032560bdd9fb4d54570bbd518bcdfa25e017ae30d79ac7edcb6e913c059013b021dd6ebd9ae9261
+  metadata.gz: 914e649b5638e024bff44c404daf3c19c0fe4b02e17ec2829b9bbe2057c8e396f48c2a4923af5774cdaacd5473e3c85f16cb88414f6e5fa8ed9a543089d16598
+  data.tar.gz: 78e811dc747f089a520f6cf39b4c8fe080a035fcb285e9b048538b614bbbce3a9099fd98763694f8946b7318896a6ade38408ab171da34a1323cbf2424f6c399

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    artemis_api (0.3.0)
+    artemis_api (0.5.1)
+      oauth2
 
 GEM
   remote: https://rubygems.org/
@@ -16,25 +17,25 @@ GEM
     concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    faraday (0.15.4)
+    faraday (1.0.1)
       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_json (1.14.1)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    oauth2 (1.4.1)
-      faraday (>= 0.8, < 0.16.0)
+    oauth2 (1.4.4)
+      faraday (>= 0.8, < 2.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)
+    rack (2.2.2)
+    rake (13.0.1)
     safe_yaml (1.0.5)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
@@ -52,8 +53,7 @@ DEPENDENCIES
   artemis_api!
   bundler (~> 1.16)
   minitest (~> 5.0)
-  oauth2
-  rake (~> 10.0)
+  rake (~> 13.0)
   webmock
 
 BUNDLED WITH

data/History.txt

@@ -1,5 +1,11 @@
 # coding: UTF-8
 
+=== 0.4.0 / 2019-11-14
+
+* Added pagination functionality to Batch queries
+* Cleaned up filtering and added tests
+* Documentation updates
+
 === 0.3.0 / 2019-11-04
 
 * Added an alternative OAuth flow that can accept an authorization code

data/README.md

@@ -56,15 +56,17 @@ client = ArtemisApi::Client.new(access_token: 'your_access_token',
                                 expires_at: token_expires_at)
 ```
 
-Alternatively, if you're working on a command line tool or otherwise not intending to implement a full OAuth flow, you can generate an authorization code directly and pass it in while instantiating your client. Do this by creating an OAuth application in your Artemis settings with `urn:ietf:wg:oauth:2.0:oob` as the callback url. Then, clicking the Authorize button directly beside it on your application show page will provide you directly with an authorization code. Pass it into the Client instantiator like this. (The same rules apply about either passing in options or setting your ENV variables.)
+Alternatively, if you're working on a command line tool or otherwise not intending to implement a full OAuth flow, you can generate an authorization code directly and use this code to obtain an access token and a refresh token.
+Do this by creating an OAuth application in your Artemis settings with `urn:ietf:wg:oauth:2.0:oob` as the callback url. Then, clicking the Authorize button directly on Artemis Portal beside it on your application show page will
+provide you directly with an authorization code. Pass it into the Client instantiator like this. (The same rules apply about either passing in options or setting your ENV variables.)
 
 ```ruby
 client = ArtemisApi::Client.new(auth_code: 'your_generated_authorization_code')
 ```
 
-This can also take an optional `redirect_uri` named param, which you can pass through if you have another callback url you're using. Otherwise if you don't pass anything through that param, it will default to the `urn:ietf:wg:oauth:2.0:oob` address.
-
-Providing your authorization code like this will do the authorization through OAuth for you and create and store your access tokens for you so you don't have to worry about them.
+This authorization code is only valid for one use. If you want to keep connecting using the same authorization grant, you
+need to save the values of `client.access_token`, `client.refresh_token` and `client.expires_at` and use them when
+reinstantiating `client` in the future.
 
 #### Requesting data from Artemis
 

data/artemis_api.gemspec

@@ -21,10 +21,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "oauth2"
+
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.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/lib/artemis_api.rb

@@ -11,6 +11,7 @@ require 'artemis_api/discard'
 require 'artemis_api/harvest'
 require 'artemis_api/seeding_unit'
 require 'artemis_api/harvest_unit'
+require 'artemis_api/resource_unit'
 require 'artemis_api/item'
 require 'artemis_api/subscription'
 

data/lib/artemis_api/batch.rb

@@ -13,11 +13,11 @@ module ArtemisApi
       client.find_all(self.json_type, facility_id: facility_id, include: include, filters: filters, page: page)
     end
 
-    def completions(include: nil)
+    def completions(include: nil, filters: {})
       ArtemisApi::Completion.find_all(facility_id: facility_id,
                                       client: client,
                                       include: include,
-                                      filters: {crop_batch_ids: [id]})
+                                      filters: {crop_batch_ids: [id]}.with_indifferent_access.merge(filters))
     end
 
     def completion(completion_id, include: nil)

data/lib/artemis_api/facility.rb

@@ -42,6 +42,14 @@ module ArtemisApi
       ArtemisApi::SeedingUnit.find(id: unit_id, facility_id: id, client: client, include: include)
     end
 
+    def resource_units(include: nil)
+      ArtemisApi::ResourceUnit.find_all(facility_id: id, client: client, include: include)
+    end
+
+    def resource_unit(unit_id, include: nil)
+      ArtemisApi::ResourceUnit.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

data/lib/artemis_api/resource_unit.rb

@@ -0,0 +1,13 @@
+module ArtemisApi
+  class ResourceUnit < ArtemisApi::Model
+    json_type 'resource_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/version.rb

@@ -1,3 +1,3 @@
 module ArtemisApi
-  VERSION = "0.4.0"
+  VERSION = "0.5.1"
 end

data/test/batch_test.rb

@@ -80,9 +80,8 @@ class BatchTest < Minitest::Test
     beginning = ending - 15.days
     date_window = [beginning, ending].join(',')
 
-    # TODO: Figure out how the filtering syntax goes.
-    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches?filter[date_type]=seeded_at&filter[date_window]=#{date_window}")
-      .to_return(body: {data: [{id: '1', type: 'batches', attributes: {id: 1, arbitrary_id: 'Oct16-Gem-Let'}}, {id: '2', type: 'batches', attributes: {id: 2, name: 'Oct19-Bok-Cho'}}]}.to_json)
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches?filter[date_type]=seeded_at&filter[date_window]=#{CGI.escape(date_window)}")
+      .to_return(body: {data: [{id: 'd1', type: 'batches', attributes: {id: 1, arbitrary_id: 'Oct16-Gem-Let'}}, {id: '2', type: 'batches', attributes: {id: 2, name: 'Oct19-Bok-Cho'}}]}.to_json)
 
     batches = ArtemisApi::Batch.find_all(facility_id: @facility.id, client: @client, filters: {date_type: "seeded_at", date_window: date_window})
     assert_equal 2, batches.count

data/test/completion_test.rb

@@ -9,10 +9,16 @@ class CompletionTest < Minitest::Test
       .to_return(body: {data: [{id: '1', type: 'completions', attributes: {id: 1, action_type: 'start'}}, {id: '2', type: 'completions', attributes: {id: 2, action_type: 'move'}}]}.to_json)
 
     stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/completions/2")
-      .to_return(body: {data: {id: '2', type: 'completions', attributes: {id: 2, action_type: 'move'}}}.to_json)
+      .to_return(body: {data: {id: '2', type: 'completions', attributes: {id: 2, action_type: 'move'}, relationships: { batch: { data: { id: 1, type: 'batches' }}}}}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/completions/2")
+      .to_return(body: {data: {id: '2', type: 'completions', attributes: {id: 2, action_type: 'move'}, relationships: { batch: { data: { id: 1, type: 'batches' }}}}}.to_json)
 
     stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/completions?filter[crop_batch_ids][]=2&filter[crop_batch_ids][]=3")
       .to_return(body: {data: [{id: '1', type: 'completions', attributes: {id: 1, action_type: 'start'}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/completions?filter[parent_id]=2")
+      .to_return(body: {data: [{id: '3', type: 'completions', attributes: {id: 3, action_type: 'process'}}, {id: '4', type: 'completions', attributes: {id: 4, action_type: 'process'}}]}.to_json)
   end
 
   def test_finding_all_completions

data/test/resource_unit_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+class ResourceUnitTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/resource_units")
+      .to_return(body: {data: [{id: '1', type: 'resource_units', attributes: {id: 1, name: 'Bunch', kind: 'count', conversion_si: 1.0}}, {id: '2', type: 'resource_units', attributes: {id: 2, name: 'grams', kind: 'weight', conversion_si: 1.0}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/resource_units/2")
+      .to_return(body: {data: {id: '2', type: 'resource_units', attributes: {id: 2, name: 'grams', kind: 'weight', conversion_is: 1.0}}}.to_json)
+  end
+
+  def test_finding_all_resource_units
+    resource_units = ArtemisApi::ResourceUnit.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, resource_units.count
+  end
+
+  def test_finding_a_specific_resource_unit
+    resource_unit = ArtemisApi::ResourceUnit.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 'grams', resource_unit.name
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: artemis_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Jamey Hampton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +66,6 @@ dependencies:
     - - "~>"
       - !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
@@ -124,6 +124,7 @@ files:
 - lib/artemis_api/item.rb
 - lib/artemis_api/model.rb
 - lib/artemis_api/organization.rb
+- lib/artemis_api/resource_unit.rb
 - lib/artemis_api/seeding_unit.rb
 - lib/artemis_api/subscription.rb
 - lib/artemis_api/user.rb
@@ -139,6 +140,7 @@ files:
 - test/harvest_unit_test.rb
 - test/item_test.rb
 - test/organization_test.rb
+- test/resource_unit_test.rb
 - test/seeding_unit_test.rb
 - test/subscription_test.rb
 - test/test_helper.rb
@@ -163,8 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An API wrapper for the ArtemisAg API