artemis_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32db9ba97ad1d05952feab8c6bd9b4ee8de457ba
-  data.tar.gz: 51c060027ec42f376727b5306458757050fefbec
+  metadata.gz: 77fb353bfa893d3ff210292444e20d71aa7dd5cf
+  data.tar.gz: 8aaa44cae9c5eec62ff7dfd524e5576ba7d79ce9
 SHA512:
-  metadata.gz: 68232ded4b5b706fd7ddcc3be017a7d054063df9af3090447449833d5eb16177da445c863eeac10153cc7b98d168fdbb7c9a23877eaf73c4cee222f38c2a8039
-  data.tar.gz: cc72bb823a05f33d8cbda6e231464aee7ed1f3555016c60952fcaeaeb9fc8c956e0d18b840a1b79fd057be6f0884002a71be9c61dc0391dc007c90de0a0f16ae
+  metadata.gz: ea1ad95a03f6f486bc66c629300f4726b912ce7213f54e7d26c2231a30a197688dac2dd93f08038b6d950b9e753f501e4b9f3225e8d1457900f63ad928393b10
+  data.tar.gz: 9d9b6ba166a362890551ae8c8b0d3f489d5b71c32e47f9851175f519ce216fec3702f703401a924673b4d97b32abd1698f816ff44f56b6d7b121e107d755b264

data/History.txt

@@ -1,5 +1,12 @@
 # coding: UTF-8
 
+=== 0.2.1 / 2019-10-28
+
+* Minor updates to documentation
+* Fix errors with gem installation
+* Don't try to delete a record if it doesn't exist
+* Using URI module to generate API urls
+
 === 0.2.0 / 2019-10-24
 
 * Added the ability to delete Subscriptions

data/README.md

@@ -6,6 +6,12 @@ This is a simple API wrapper for the [Artemis](https://artemisag.com/) API.
 
 Add this line to your application's Gemfile:
 
+```ruby
+gem 'artemis_api'
+```
+
+If you want to ensure the most up to date version, you can also use the gem straight from the repository:
+
 ```ruby
 gem 'artemis_api', :git => 'https://github.com/artemis-ag/artemis_api'
 ```
@@ -168,6 +174,12 @@ ArtemisApi::Subscription.create(facility_id: 2,
 facility.create_subscription(subject: 'completions', destination: 'https://test-app-url.artemisag.io/v1/webhook')
 ```
 
+You can also delete one of your own Subscriptions. Trying to delete a Subscription that isn't associated with your user account will fail.
+
+```ruby
+ArtemisApi::Subscription.delete(id: 1, facility_id: 2, client: client)
+```
+
 ## 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.

data/artemis_api.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
+    f.match(/\.gem$/)
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/artemis_api/client.rb

@@ -27,12 +27,16 @@ module ArtemisApi
       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
+        path = if facility_id
+                 "/api/v3/facilities/#{facility_id}/#{type}/#{id}"
+               else
+                 "/api/v3/#{type}/#{id}"
+               end
+
+        query = {}
+        query[:include] = include if include
+
+        url = build_url(path: path, query: URI.encode_www_form(query))
 
         response = @oauth_token.get(url)
         obj = process_response(response, type) if response.status == 200
@@ -44,19 +48,19 @@ module ArtemisApi
       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
+      path = if facility_id && batch_id
+               "/api/v3/facilities/#{facility_id}/batches/#{batch_id}/#{type}"
+             elsif facility_id && batch_id.nil?
+               "/api/v3/facilities/#{facility_id}/#{type}"
+             else
+               "/api/v3/#{type}"
+             end
+
+      query = {}
+      query[:include] = include if include
+      format_filters(filters, query) if filters
+
+      url = build_url(path: path, query: URI.encode_www_form(query))
 
       response = @oauth_token.get(url)
       if response.status == 200
@@ -65,13 +69,26 @@ module ArtemisApi
       records
     end
 
+    def build_url(path:, query: nil)
+      uri = URI::Generic.build(path: path, query: query)
+      @options[:base_uri] + uri.to_s
+    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)
+      @objects.dig(type, id.to_i)
+    end
+
+    def remove_record(type, id)
+      @objects[type].delete(id.to_i) if record_stored?(type, id)
+    end
+
+    def record_stored?(type, id)
+      get_record(type, id).present?
     end
 
     def remove_record(type, id)
@@ -129,18 +146,14 @@ module ArtemisApi
       end
     end
 
-    def format_filters(filter_hash)
-      filter_string = ''
+    def format_filters(filter_hash, query_hash)
       filter_hash.each do |k, v|
         if v.kind_of?(Array)
-          v.each do |item|
-            filter_string += "filter[#{k}][]=#{item}&"
-          end
+          query_hash[:"filter[#{k}][]"] = v
         else
-          filter_string += "filter[#{k}]=#{v}&"
+          query_hash[:"filter[#{k}]"] = v
         end
       end
-      filter_string
     end
   end
 end

data/lib/artemis_api/version.rb

@@ -1,3 +1,3 @@
 module ArtemisApi
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/artemis_api_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class ArtemisApiTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::ArtemisApi::VERSION
+  end
+end

data/test/batch_test.rb

@@ -0,0 +1,58 @@
+require "test_helper"
+
+class BatchTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches")
+      .to_return(body: {data: [{id: '1', type: 'batches', attributes: {id: 1, arbitrary_id: 'Jun16-Gem-Let'}}, {id: '2', type: 'batches', attributes: {id: 2, name: 'Jun19-Bok-Cho'}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches/2")
+      .to_return(body: {data: {id: '2', type: 'batches', attributes: {id: 2, arbitrary_id: 'Jun19-Bok-Cho'}}}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches/2?include=zone")
+      .to_return(body: {data:
+                         {id: '2',
+                          type: 'batches',
+                          attributes: {id: 2, arbitrary_id: 'Jun19-Bok-Cho'},
+                          relationships: {zone: {data: {id: 1, type: 'zones'}}}
+                        },
+                        included: [{id: '1', type: 'zones', attributes: {id: 1, name: 'Germination'}}]}.to_json)
+  end
+
+  def test_finding_all_batches
+    batches = ArtemisApi::Batch.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, batches.count
+  end
+
+  def test_finding_all_batches_through_facility
+    batches = @facility.batches
+    assert_equal 2, batches.count
+  end
+
+  def test_finding_a_specific_batch
+    batch = ArtemisApi::Batch.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 'Jun19-Bok-Cho', batch.arbitrary_id
+  end
+
+  def test_finding_a_specific_batch_through_facility
+    batch = @facility.batch(2)
+    assert_equal 'Jun19-Bok-Cho', batch.arbitrary_id
+  end
+
+  def test_finding_a_batch_with_zone_included
+    batch = ArtemisApi::Batch.find(id: 2, facility_id: @facility.id, client: @client, include: "zone")
+    assert_equal 'Jun19-Bok-Cho', batch.arbitrary_id
+    assert_equal @client.objects['zones'].count, 1
+
+    zone = ArtemisApi::Zone.find(id: 1, facility_id: @facility.id, client: @client)
+    assert_equal zone.name, 'Germination'
+  end
+
+  def test_related_to_one_zone
+    batch = ArtemisApi::Batch.find(id: 2, facility_id: @facility.id, client: @client, include: "zone")
+    zone = batch.zone
+    assert_equal zone.name, 'Germination'
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class ClientTest < Minitest::Test
+  def stub_user
+    stub_request(:get, "http://localhost:3000/api/v3/user")
+      .to_return(body: {data: {id: '41', type: 'users', attributes: {id: 41, full_name: 'Jamey Hampton', email: 'jhampton@artemisag.com'}}}.to_json)
+  end
+
+  def test_creating_a_client_instance
+    get_client
+
+    assert_equal '12345', @client.oauth_client.id
+    assert_equal 'ya29', @client.oauth_token.token
+    assert_equal @expires_at.to_i, @client.oauth_token.expires_at
+    assert_equal false, @client.oauth_token.expired?
+  end
+
+  def test_current_user
+    get_client
+    stub_user
+
+    user = @client.current_user
+    assert_equal user.class, ArtemisApi::User
+  end
+end

data/test/completion_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+class CompletionTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/completions")
+      .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)
+  end
+
+  def test_finding_all_completions
+    completions = ArtemisApi::Completion.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, completions.count
+  end
+
+  def test_finding_a_specific_completion
+    completion = ArtemisApi::Completion.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 'move', completion.action_type
+  end
+end

data/test/discard_test.rb

@@ -0,0 +1,85 @@
+require "test_helper"
+
+class DiscardTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/2/discards/2")
+      .to_return(body: {
+        data: {
+          id: '2',
+          type: 'discards',
+          attributes: {
+            id: 2,
+            quantity: 20,
+            reason_type: 'disease',
+            reason_description: ''
+          },
+          relationships: {
+            batch: {
+              meta: {
+                included: false
+              }
+            },
+            completion: {
+              meta: {
+                included: false
+              }
+            }
+          }
+        }
+      }.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/2/discards/2?include=batch")
+      .to_return(body: {
+        data: {
+          id: '2',
+          type: 'discards',
+          attributes: {
+            id: 2,
+            quantity: 20,
+            reason_type: 'disease',
+            reason_description: ''
+          },
+          relationships: {
+            batch: {
+              data: {
+                id: '156',
+                type: 'batches'
+              }
+            },
+            completion: {
+              meta: {
+                included: false
+              }
+            }
+          }
+        }
+      }.to_json)
+
+      stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/discards")
+        .to_return(body: {data: [{id: '1', type: 'discards', attributes: {id: 1, reason_type: 'disease', quantity: 20}}, {id: '2', type: 'discards', attributes: {id: 2, reason_type: 'pests', quantity: 5}}]}.to_json)
+  end
+
+  def test_finding_a_specific_discard
+    discard = ArtemisApi::Discard.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 20, discard.quantity
+    assert_equal 'disease', discard.reason_type
+    assert_equal false, discard.relationships['batch']['meta']['included']
+    assert discard.relationships['batch']['data'].nil?
+  end
+
+  def test_finding_a_specific_discard_with_batch_included
+    discard = ArtemisApi::Discard.find(id: 2, facility_id: @facility.id, client: @client, include: 'batch')
+    assert_equal 20, discard.quantity
+    assert_equal 'disease', discard.reason_type
+    assert_equal '156', discard.relationships['batch']['data']['id']
+    assert discard.relationships['batch']['meta'].nil?
+  end
+
+  def test_finding_all_discards
+    discards = ArtemisApi::Discard.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, discards.count
+  end
+end

data/test/facility_test.rb

@@ -0,0 +1,42 @@
+require "test_helper"
+
+class FacilityTest < Minitest::Test
+  def setup
+    get_client
+
+    stub_request(:get, 'http://localhost:3000/api/v3/facilities')
+      .to_return(body: {data: [{id: '1', type: 'facilities', attributes: {id: 1, name: 'Sky Fresh'}}, {id: '2', type: 'facilities', attributes: {id: 2, name: 'Rare Dankness'}}]}.to_json)
+  end
+
+  def test_finding_all_facilities
+    facilities = ArtemisApi::Facility.find_all(client: @client)
+    assert_equal 2, facilities.count
+  end
+
+  def test_finding_all_facilities_through_client
+    facilities = @client.facilities
+    assert_equal 2, facilities.count
+  end
+
+  def test_finding_a_specific_facility
+    stub_request(:get, 'http://localhost:3000/api/v3/facilities/2')
+      .to_return(body: {data: {id: '2', type: 'facilities', attributes: {id: 2, name: 'Rare Dankness'}}}.to_json)
+
+    facility = ArtemisApi::Facility.find(id: 2, client: @client)
+    assert_equal 'Rare Dankness', facility.name
+  end
+
+  def test_finding_a_specific_facility_through_client
+    stub_request(:get, 'http://localhost:3000/api/v3/facilities/2')
+      .to_return(body: {data: {id: '2', type: 'facilities', attributes: {id: 2, name: 'Rare Dankness'}}}.to_json)
+
+    facility = @client.facility(2)
+    assert_equal 'Rare Dankness', facility.name
+  end
+
+  def test_finding_a_specific_facility_thats_already_in_memory
+    ArtemisApi::Facility.find_all(client: @client)
+    facility = ArtemisApi::Facility.find(id: 2, client: @client)
+    assert_equal 'Rare Dankness', facility.name
+  end
+end

data/test/harvest_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+class HarvestTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/harvests")
+      .to_return(body: {data: [{id: '1', type: 'harvests', attributes: {id: 1, quantity: 4, harvest_type: 'complete'}}, {id: '2', type: 'harvests', attributes: {id: 2, quantity: 1, harvest_type: 'partial'}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/harvests/2")
+      .to_return(body: {data: {id: '2', type: 'harvests', attributes: {id: 2, quantity: 1, harvest_type: 'partial'}}}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/harvests?filter[crop_batch_ids][]=2&filter[crop_batch_ids][]=3")
+      .to_return(body: {data: [{id: '1', type: 'harvests', attributes: {id: 1, quantity: 4, harvest_type: 'complete'}}]}.to_json)
+  end
+
+  def test_finding_all_harvests
+    harvests = ArtemisApi::Harvest.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, harvests.count
+  end
+
+  def test_finding_a_specific_harvest
+    harvest = ArtemisApi::Harvest.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 'partial', harvest.harvest_type
+    assert_equal 1, harvest.quantity
+  end
+
+  def test_filtering_harvest_by_crop_batch_ids
+    harvests = ArtemisApi::Harvest.find_all(facility_id: @facility.id, client: @client, filters: {crop_batch_ids: [2, 3]})
+    assert_equal 1, harvests.count
+  end
+end

data/test/harvest_unit_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class HarvestUnitTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/harvest_units")
+      .to_return(body: {data: [{id: '1', type: 'harvest_units', attributes: {id: 1, name: 'pound', weight: 1}}, {id: '2', type: 'harvest_units', attributes: {id: 2, name: 'kilogram', weight: 2.2}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/harvest_units/2")
+      .to_return(body: {data: {id: '2', type: 'harvest_units', attributes: {id: 2, name: 'kilogram', weight: 2.2}}}.to_json)
+  end
+
+  def test_finding_all_harvest_units
+    harvest_units = ArtemisApi::HarvestUnit.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, harvest_units.count
+  end
+
+  def test_finding_a_specific_harvest_unit
+    harvest_unit = ArtemisApi::HarvestUnit.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 'kilogram', harvest_unit.name
+    assert_equal 2.2, harvest_unit.weight
+  end
+end

data/test/item_test.rb

@@ -0,0 +1,38 @@
+require "test_helper"
+
+class ItemTest < Minitest::Test
+  def setup
+    get_client
+
+    stub_request(:get, 'http://localhost:3000/api/v3/facilities/2')
+      .to_return(body: {data: {id: '2', type: 'facilities', attributes: {id: 2, name: 'Rare Dankness'}}}.to_json)
+    @facility = ArtemisApi::Facility.find(id: 2, client: @client)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches/2")
+      .to_return(body: {data: {id: '2', type: 'batches', attributes: {id: 2, arbitrary_id: 'Jun19-Bok-Cho'}, relationships: {seeding_unit: {data: {id: '3479', type: 'seeding_units'}}}}}.to_json)
+    @batch = ArtemisApi::Batch.find(id: 2, facility_id: @facility.id, client: @client)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches/2/items")
+      .to_return(body: {data: [{id: '326515', type: 'items', attributes: {id: 326515, status: 'active'}, relationships: {barcode: {data: {id: '1A4FF0200000022000000207', type: 'barcodes'}}}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches/2/items?filter[seeding_unit_id]=100")
+      .to_return(body: {data: [{id: '326515', type: 'items', attributes: {id: 326515, status: 'active'}, relationships: {barcode: {data: {id: '1A4FF0200000022000000207', type: 'barcodes'}}, seeding_unit: {data: {id: '100', type: 'seeding_units'}}}}]}.to_json)
+  end
+
+  def test_finding_all_items_of_facility_and_batch
+    items = ArtemisApi::Item.find_all(facility_id: @facility.id, batch_id: @batch.id, client: @client)
+    assert_equal 1, items.count
+    assert_equal 326_515, items.first.id
+    assert_equal '1A4FF0200000022000000207', items.first.relationships.dig('barcode', 'data', 'id')
+  end
+
+  def test_finding_all_items_with_seeding_unit
+    seeding_unit_id = 100
+    items = ArtemisApi::Item.find_all(facility_id: @facility.id,
+                                       batch_id: @batch.id,
+                                       client: @client,
+                                       filters: {seeding_unit_id: seeding_unit_id})
+    assert_equal 1, items.count
+    assert_equal seeding_unit_id.to_s, items.first.relationships.dig('seeding_unit', 'data', 'id')
+  end
+end

data/test/organization_test.rb

@@ -0,0 +1,39 @@
+require "test_helper"
+
+class OrganizationTest < Minitest::Test
+  def setup
+    get_client
+
+    stub_request(:get, 'http://localhost:3000/api/v3/organizations')
+      .to_return(body: {data: [{id: '1', type: 'organizations', attributes: {id: 1, name: 'Sky Fresh'}}, {id: '2', type: 'organizations', attributes: {id: 2, name: 'Rare Dankness'}}]}.to_json)
+  end
+
+  def test_finding_all_organizations
+    organizations = ArtemisApi::Organization.find_all(client: @client)
+    assert_equal 2, organizations.count
+  end
+
+  def test_finding_a_specific_organization
+    stub_request(:get, 'http://localhost:3000/api/v3/organizations/2')
+      .to_return(body: {data: {id: '2', type: 'organizations', attributes: {id: 2, name: 'Rare Dankness'}}}.to_json)
+
+    org = ArtemisApi::Organization.find(id: 2, client: @client)
+    assert_equal 'Rare Dankness', org.name
+  end
+
+  def test_finding_a_specific_org_thats_already_in_memory
+    ArtemisApi::Organization.find_all(client: @client)
+    org = ArtemisApi::Organization.find(id: 2, client: @client)
+    assert_equal 'Rare Dankness', org.name
+  end
+
+  def test_getting_orgs_with_facilities_included
+    stub_request(:get, 'http://localhost:3000/api/v3/organizations/2?include=facilities')
+      .to_return(body: {data: {id: '2', type: 'organizations', attributes: {id: 2, name: 'Rare Dankness'}}, included: [{id: 1, type: "facilities", attributes: {id: 1, name: 'Sky Fresh'}}]}.to_json)
+
+    org = ArtemisApi::Organization.find(id: 2, client: @client, include: 'facilities')
+    facility = ArtemisApi::Facility.find(id: 1, client: @client)
+    assert_equal 'Rare Dankness', org.name
+    assert_equal 'Sky Fresh', facility.name
+  end
+end

data/test/seeding_unit_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+class SeedingUnitTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/seeding_units")
+      .to_return(body: {data: [{id: '1', type: 'seeding_units', attributes: {id: 1, name: 'board'}}, {id: '2', type: 'seeding_units', attributes: {id: 2, name: 'raft'}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/seeding_units/2")
+      .to_return(body: {data: {id: '2', type: 'seeding_units', attributes: {id: 2, name: 'raft'}}}.to_json)
+  end
+
+  def test_finding_all_seeding_units
+    seeding_units = ArtemisApi::SeedingUnit.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, seeding_units.count
+  end
+
+  def test_finding_a_specific_seeding_unit
+    seeding_unit = ArtemisApi::SeedingUnit.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 'raft', seeding_unit.name
+  end
+end

data/test/subscription_test.rb

@@ -0,0 +1,63 @@
+require "test_helper"
+
+class SubscriptionTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/subscriptions")
+      .to_return(body: {data: [{id: '1', type: 'subscriptions', attributes: {id: 1, subject: 'completions', destination: 'http://localhost:8080/a/fake/url'}}, {id: '2', type: 'subscriptions', attributes: {id: 2, subject: 'batches', destination: 'http://localhost:8080/another/fake/url'}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/subscriptions/2")
+      .to_return(body: {data: {id: '2', type: 'subscriptions', attributes: {id: 2, subject: 'batches', destination: 'http://localhost:8080/another/fake/url'}}}.to_json)
+
+    stub_request(:post, "http://localhost:3000/api/v3/facilities/#{@facility.id}/subscriptions")
+      .with(body: {"subscription"=>{"destination"=>"http://localhost:8080/a/fake/url", "subject"=>"completions"}})
+      .to_return(status: 200, body: {data: {id: '3', type: 'subscriptions', attributes: {id: 3, subject: 'completions', destination: 'http://localhost:8080/a/fake/url'}}}.to_json)
+
+    stub_request(:delete, "http://localhost:3000/api/v3/facilities/#{@facility.id}/subscriptions/2")
+      .to_return(status: 204, body: {}.to_json)
+  end
+
+  def test_finding_all_subscriptions
+    subscriptions = ArtemisApi::Subscription.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, subscriptions.count
+  end
+
+  def test_finding_all_subscriptions_through_facility
+    subscriptions = @facility.subscriptions
+    assert_equal 2, subscriptions.count
+  end
+
+  def test_finding_a_specific_subscription
+    subscription = ArtemisApi::Subscription.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 'batches', subscription.subject
+    assert_equal 'http://localhost:8080/another/fake/url', subscription.destination
+  end
+
+  def test_finding_a_specific_subscription_through_facility
+    subscription = @facility.subscription(2)
+    assert_equal 'batches', subscription.subject
+    assert_equal 'http://localhost:8080/another/fake/url', subscription.destination
+  end
+
+  def test_creating_a_new_subscription
+    subscription = ArtemisApi::Subscription.create(facility_id: @facility.id,
+                                                   subject: 'completions',
+                                                   destination: 'http://localhost:8080/a/fake/url',
+                                                   client: @client)
+    assert_equal 'completions', subscription.subject
+    assert_equal 'http://localhost:8080/a/fake/url', subscription.destination
+    assert_equal 1, @client.objects['subscriptions'].count
+  end
+
+  def test_deleting_a_subscription
+    # find the subscription first to ensure it's in the objects hash
+    subscription = ArtemisApi::Subscription.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 1, @client.objects['subscriptions'].count
+
+    # then delete it and ensure it has been removed from the objects hash
+    result = ArtemisApi::Subscription.delete(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 0, @client.objects['subscriptions'].count
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "artemis_api"
+
+require "minitest/autorun"
+require "webmock/minitest"
+require "active_support"
+require "active_support/core_ext/numeric"
+require 'active_support/testing/assertions'
+include ActiveSupport::Testing::Assertions
+
+def get_client
+  options = {app_id: '12345',
+             app_secret: '67890',
+             base_uri: 'http://localhost:3000'}
+  @expires_at = 1.days.from_now
+  @client = ArtemisApi::Client.new(access_token: 'ya29',
+                                   refresh_token: 'eyJh',
+                                   expires_at: @expires_at,
+                                   options: options)
+end
+
+def get_facility
+  stub_request(:get, 'http://localhost:3000/api/v3/facilities/2')
+    .to_return(body: {data: {id: '2', type: 'facilities', attributes: {id: 2, name: 'Rare Dankness'}}}.to_json)
+  @facility = ArtemisApi::Facility.find(id: 2, client: @client)
+end

data/test/user_test.rb

@@ -0,0 +1,66 @@
+require "test_helper"
+
+class UserTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/user")
+      .to_return(body: {data: {id: '41', type: 'users', attributes: {id: 41, full_name: 'Jamey Hampton', email: 'jhampton@artemisag.com'}}}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/users")
+      .to_return(body: {data: [{id: '41', type: 'users', attributes: {id: 41, full_name: 'Jamey Hampton', email: 'jhampton@artemisag.com'}}, {id: '42', type: 'users', attributes: {id: 42, full_name: 'Developer', email: 'developer@artemisag.com'}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/users/42")
+      .to_return(body: {data: {id: '42', type: 'users', attributes: {id: 42, full_name: 'Developer', email: 'developer@artemisag.com'}}}.to_json)
+  end
+
+  def test_getting_current_user
+    user = ArtemisApi::User.get_current(client: @client)
+    assert_equal user.id, 41
+    assert_equal user.full_name, 'Jamey Hampton'
+    assert_equal user.email, 'jhampton@artemisag.com'
+  end
+
+  def test_finding_all_users
+    users = ArtemisApi::User.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, users.count
+    assert_equal 2, @client.objects['users'].count
+  end
+
+  def test_finding_all_users_through_facility
+    users = @facility.users
+    assert_equal 2, users.count
+  end
+
+  def test_finding_a_specific_user
+    user = ArtemisApi::User.find(id: 42, facility_id: @facility.id, client: @client)
+    assert_equal user.full_name, 'Developer'
+    assert_equal user.email, 'developer@artemisag.com'
+  end
+
+  def test_finding_a_specific_user_through_facility
+    user = @facility.user(42)
+    assert_equal user.full_name, 'Developer'
+    assert_equal user.email, 'developer@artemisag.com'
+  end
+
+  def test_finding_a_user_with_included_organizations
+    stub_request(:get, 'http://localhost:3000/api/v3/facilities/2/users/42?include=organizations')
+      .to_return(body: {data:
+                         {id: '42',
+                          type: 'users',
+                          attributes: {id: 42, full_name: 'Developer', email: 'developer@artemisag.com'}},
+                        included: [{id: '1', type: 'organizations', attributes: {id: 1, name: 'Vegetable Sky'}}]}.to_json)
+
+    user = ArtemisApi::User.find(id: 42, facility_id: @facility.id, client: @client, include: "organizations")
+    assert_equal user.full_name, 'Developer'
+    assert_equal user.email, 'developer@artemisag.com'
+    assert_equal @client.objects['organizations'].count, 1
+
+    # Since the organization has already been included and stored in the client objects array,
+    # this call doesn't actually hit the API and consdoesn't need to be stubbed.
+    organization = ArtemisApi::Organization.find(id: 1, client: @client)
+    assert_equal organization.name, 'Vegetable Sky'
+  end
+end

data/test/zone_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+
+class ZoneTest < Minitest::Test
+  def setup
+    get_client
+    get_facility
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/zones")
+      .to_return(body: {data: [{id: '1', type: 'zones', attributes: {id: 1, name: 'Germination'}}, {id: '2', type: 'zones', attributes: {id: 2, name: 'Propagation'}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/zones/2")
+      .to_return(body: {data: {id: '2', type: 'zones', attributes: {id: 2, name: 'Propagation'}}}.to_json)
+  end
+
+  def test_finding_all_zones
+    zones = ArtemisApi::Zone.find_all(facility_id: @facility.id, client: @client)
+    assert_equal 2, zones.count
+  end
+
+  def test_finding_all_zones_through_facility
+    zones = @facility.zones
+    assert_equal 2, zones.count
+  end
+
+  def test_finding_a_specific_zone
+    zone = ArtemisApi::Zone.find(id: 2, facility_id: @facility.id, client: @client)
+    assert_equal 'Propagation', zone.name
+  end
+
+  def test_finding_a_specific_zone_through_facility
+    zone = @facility.zone(2)
+    assert_equal 'Propagation', zone.name
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artemis_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jamey Hampton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,7 +110,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- artemis_api-0.1.0.gem
 - artemis_api.gemspec
 - bin/console
 - bin/setup
@@ -130,6 +129,21 @@ files:
 - lib/artemis_api/user.rb
 - lib/artemis_api/version.rb
 - lib/artemis_api/zone.rb
+- test/artemis_api_test.rb
+- test/batch_test.rb
+- test/client_test.rb
+- test/completion_test.rb
+- test/discard_test.rb
+- test/facility_test.rb
+- test/harvest_test.rb
+- test/harvest_unit_test.rb
+- test/item_test.rb
+- test/organization_test.rb
+- test/seeding_unit_test.rb
+- test/subscription_test.rb
+- test/test_helper.rb
+- test/user_test.rb
+- test/zone_test.rb
 homepage: https://github.com/artemis-ag/artemis_api/
 licenses:
 - MIT