artemis_api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e8888de9d53b67758011986d95da48078a539d1
-  data.tar.gz: 70e7223008c998a11c2e8c195bb9ab2e44048167
+  metadata.gz: 0ddb2f3f02a23e8af40bb40ac71a3ce9a5a6c37e
+  data.tar.gz: 1e63ef8698d8bed206674ff165a82f7fe404a64d
 SHA512:
-  metadata.gz: 2f0afda52acc388593a3c704fea8593e09af8713c8d9cfa64c7ec6a9b7e99960465a732202c2b69358371f8f77f5fd59ae48033737e609428073a1d7e41bbd97
-  data.tar.gz: 77da6377c501a342397d87438d1fa41f9d44d21dfd67e434b188bb147d50e5e1768ed8b9070dafc9f3a4c1f1fc38620a834bbf1a4c5c4dc2771820c83191debe
+  metadata.gz: a50bcb4e50699bd837c933bbea113b33454ec61a00233c6ae5e204bf7a5f4cbd00cb4d1225537da8df8d65a382d1704c73fb9ac4571763f1c9e8314a4b29d7d1
+  data.tar.gz: 3a1d56165f91ac90ed852f39e5e355efc946e18d8f22ce8a1032560bdd9fb4d54570bbd518bcdfa25e017ae30d79ac7edcb6e913c059013b021dd6ebd9ae9261

data/README.md

@@ -166,8 +166,10 @@ ArtemisApi::Batch.find(id: 22, facility_id: 2, client: client, include: "complet
 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: {search: 'genovese basil'})
 ArtemisApi::Batch.find_all(facility_id: 2, client: client, filters: {ids: [2, 4, 6, 11]})
+ArtemisApi::Batch.find_all(facility_id: 2, client: client, filters: {date_type: 'seeded_at', date_window: "2019-10-31 17:06:42 -0400,2019-11-15 17:06:42 -0500"})
+
 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]})
@@ -177,6 +179,12 @@ ArtemisApi::Item.find_all(facility_id: 2, batch_id: 22, client: client, filters:
 
 Note that when you filter by ids or crop_batch_ids, you must pass in an array even if it only has one element.
 
+Pagination is also supported on batches, and is also an optional param that expects a hash. We use the limit/offset method of pagination.
+
+```ruby
+ArtemisApi::Batch.find_all(facility_id: 2, client: client, page: {limit: 10, offset: 60})
+```
+
 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

data/lib/artemis_api/batch.rb

@@ -9,8 +9,8 @@ module ArtemisApi
       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)
+    def self.find_all(client:, facility_id:, include: nil, filters: nil, page: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include, filters: filters, page: page)
     end
 
     def completions(include: nil)

data/lib/artemis_api/client.rb

@@ -60,7 +60,7 @@ module ArtemisApi
       obj
     end
 
-    def find_all(type, facility_id: nil, batch_id: nil, include: nil, filters: nil)
+    def find_all(type, facility_id: nil, batch_id: nil, include: nil, filters: nil, page: nil)
       records = []
       refresh if @oauth_token.expired?
 
@@ -75,6 +75,7 @@ module ArtemisApi
       query = {}
       query[:include] = include if include
       format_filters(filters, query) if filters
+      format_pagination(page, query) if page
 
       url = build_url(path: path, query: URI.encode_www_form(query))
 
@@ -163,5 +164,11 @@ module ArtemisApi
         end
       end
     end
+
+    def format_pagination(page_hash, query_hash)
+      page_hash.each do |k, v|
+        query_hash[:"page[#{k}]"] = v
+      end
+    end
   end
 end

data/lib/artemis_api/subscription.rb

@@ -6,8 +6,8 @@ module ArtemisApi
       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)
+    def self.find_all(facility_id:, client:, include: nil)
+      client.find_all(self.json_type, facility_id: facility_id, include: include)
     end
 
     def self.create(facility_id:, subject:, destination:, client:)

data/lib/artemis_api/version.rb

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

data/test/batch_test.rb

@@ -19,6 +19,15 @@ class BatchTest < Minitest::Test
                           relationships: {zone: {data: {id: 1, type: 'zones'}}}
                         },
                         included: [{id: '1', type: 'zones', attributes: {id: 1, name: 'Germination'}}]}.to_json)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/batches?filter[search]=oct")
+      .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[ids][]=2&filter[ids][]=3")
+      .to_return(body: {data: [{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?page[limit]=1&page[offset]=4")
+      .to_return(body: {data: [{id: '2', type: 'batches', attributes: {id: 2, name: 'Oct19-Bok-Cho'}}]}.to_json)
   end
 
   def test_finding_all_batches
@@ -55,4 +64,32 @@ class BatchTest < Minitest::Test
     zone = batch.zone
     assert_equal zone.name, 'Germination'
   end
+
+  def test_filtering_by_search_term
+    batches = ArtemisApi::Batch.find_all(facility_id: @facility.id, client: @client, filters: {search: "oct"})
+    assert_equal 2, batches.count
+  end
+
+  def test_filtering_by_ids
+    batches = ArtemisApi::Batch.find_all(facility_id: @facility.id, client: @client, filters: {ids: [2, 3]})
+    assert_equal 1, batches.count
+  end
+
+  def test_filtering_by_date_window
+    ending = Time.now + 2.day
+    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)
+
+    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
+  end
+
+  def test_pagination
+    batches = ArtemisApi::Batch.find_all(facility_id: @facility.id, client: @client, page: {limit: 1, offset: 4})
+    assert_equal 1, batches.count
+  end
 end

data/test/completion_test.rb

@@ -10,6 +10,9 @@ class CompletionTest < Minitest::Test
 
     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)
+
+    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)
   end
 
   def test_finding_all_completions
@@ -21,4 +24,9 @@ class CompletionTest < Minitest::Test
     completion = ArtemisApi::Completion.find(id: 2, facility_id: @facility.id, client: @client)
     assert_equal 'move', completion.action_type
   end
+
+  def test_filtering_completion_by_crop_batch_ids
+    completions = ArtemisApi::Completion.find_all(facility_id: @facility.id, client: @client, filters: {crop_batch_ids: [2, 3]})
+    assert_equal 1, completions.count
+  end
 end

data/test/discard_test.rb

@@ -60,6 +60,9 @@ class DiscardTest < Minitest::Test
 
       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)
+
+      stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/discards?filter[crop_batch_ids][]=2&filter[crop_batch_ids][]=3")
+        .to_return(body: {data: [{id: '1', type: 'discards', attributes: {id: 1, quantity: 4, reason_type: 'pests'}}]}.to_json)
   end
 
   def test_finding_a_specific_discard
@@ -82,4 +85,9 @@ class DiscardTest < Minitest::Test
     discards = ArtemisApi::Discard.find_all(facility_id: @facility.id, client: @client)
     assert_equal 2, discards.count
   end
+
+  def test_filtering_discard_by_crop_batch_ids
+    discards = ArtemisApi::Discard.find_all(facility_id: @facility.id, client: @client, filters: {crop_batch_ids: [2, 3]})
+    assert_equal 1, discards.count
+  end
 end

data/test/zone_test.rb

@@ -10,6 +10,9 @@ class ZoneTest < Minitest::Test
 
     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)
+
+    stub_request(:get, "http://localhost:3000/api/v3/facilities/#{@facility.id}/zones?filter[seeding_unit_id]=100")
+      .to_return(body: {data: [{id: '2', type: 'zones', attributes: {id: 2, name: 'Propagation'}}]}.to_json)
   end
 
   def test_finding_all_zones
@@ -31,4 +34,9 @@ class ZoneTest < Minitest::Test
     zone = @facility.zone(2)
     assert_equal 'Propagation', zone.name
   end
+
+  def test_filtering_zones_by_seeding_unit_id
+    zones = ArtemisApi::Zone.find_all(facility_id: @facility.id, client: @client, filters: {seeding_unit_id: 100})
+    assert_equal 1, zones.count
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artemis_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jamey Hampton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler