artemis_api 0.2.0 → 0.7.4

data/lib/artemis_api/crop_variety.rb

@@ -0,0 +1,5 @@
+module ArtemisApi
+  class CropVariety < ArtemisApi::Model
+    json_type 'crop_varieties'
+  end
+end

data/lib/artemis_api/custom_data.rb

@@ -0,0 +1,5 @@
+module ArtemisApi
+  class CustomData < ArtemisApi::Model
+    json_type 'custom_data'
+  end
+end

data/lib/artemis_api/custom_fields.rb

@@ -0,0 +1,5 @@
+module ArtemisApi
+  class CustomFields < ArtemisApi::Model
+    json_type 'custom_fields'
+  end
+end

data/lib/artemis_api/facility.rb

@@ -14,40 +14,48 @@ module ArtemisApi
       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)
+    def zone(zone_id, include: nil, force: false)
+      ArtemisApi::Zone.find(id: zone_id, facility_id: id, client: client, include: include, force: force)
     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)
+    def batch(batch_id, include: nil, force: false)
+      ArtemisApi::Batch.find(id: batch_id, facility_id: id, client: client, include: include, force: force)
     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)
+    def user(user_id, include: nil, force: false)
+      ArtemisApi::User.find(id: user_id, facility_id: id, client: client, include: include, force: force)
     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)
+    def seeding_unit(unit_id, include: nil, force: false)
+      ArtemisApi::SeedingUnit.find(id: unit_id, facility_id: id, client: client, include: include, force: force)
+    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, force: false)
+      ArtemisApi::ResourceUnit.find(id: unit_id, facility_id: id, client: client, include: include, force: force)
     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)
+    def harvest_unit(unit_id, include: nil, force: false)
+      ArtemisApi::HarvestUnit.find(id: unit_id, facility_id: id, client: client, include: include, force: force)
     end
 
     def subscriptions
@@ -58,6 +66,14 @@ module ArtemisApi
       ArtemisApi::Subscription.find(id: subscription_id, facility_id: id, client: client)
     end
 
+    def stages
+      ArtemisApi::Stage.find_all(id, client)
+    end
+
+    def stage(stage_id)
+      ArtemisApi::Stage.find(stage_id, id, client)
+    end
+
     def create_subscription(subject:, destination:)
       ArtemisApi::Subscription.create(facility_id: id, subject: subject, destination: destination, client: client)
     end

data/lib/artemis_api/model.rb

@@ -1,42 +1,85 @@
 module ArtemisApi
   class Model
-    attr_reader :client, :id, :attributes, :relationships
+    attr_reader :client, :id, :attributes, :relationships, :included
 
-    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'])
+    class << self
+      def related_to_one(name)
+        register_relationship(name)
+
+        send(:define_method, name.to_sym) do
+          related_id = relationships.dig(name.to_s, 'data', 'id')
+          included = client.get_record(name.to_s, related_id)
+
+          return included if included&.present?
+
+          relationship = relationships.dig(name.to_s, 'data')
+          return if relationship.nil?
+
+          @client.find_one(relationship['type'], relationship['id']) unless relationship['id'].to_s.empty? || relationship['id'].nil?
+        end
       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'])
+      def related_to_many(name)
+        register_relationship(name)
+
+        send(:define_method, name.to_sym) do
+          included = relationships.dig(name.to_s, 'data')&.map do |related|
+            client.get_record(name.to_s, related['id'])
+          end
+
+          return included if included&.present?
+
+          @client.find_all(
+            relationships.dig(name.to_s, 'data', 0, 'type') || name.to_s,
+            filters: { name => id }
+          )
+        end
       end
-    end
 
-    def self.json_type(type = nil)
-      if type
-        @json_type = type
-        @@registered_classes ||= {}
-        @@registered_classes[type] = self
+      def json_type(type = nil)
+        if type
+          @json_type = type
+          @@registered_classes ||= {}
+          @@registered_classes[type] = self
+        end
+        @json_type
       end
-      @json_type
-    end
 
-    def self.instance_for(type, data, client)
-      @@registered_classes[type]&.new(client, data)
+      def instance_for(type, data, included, client)
+        @@registered_classes[type]&.new(client, data, included)
+      end
+
+      def relationships
+        @relationships ||= []
+      end
+
+      private
+
+      def register_relationship(name)
+        relationships << name.to_sym
+      end
     end
 
     def method_missing(name)
-      attributes[name.to_s]
+      respond_to_missing?(name) ? attributes[name.to_s] : super
+    end
+
+    def respond_to_missing?(name)
+      attributes.key?(name.to_s)
     end
 
-    def initialize(client, data)
+    def initialize(client, data, included = nil)
       @client = client
       @id = data['id'].to_i
       @attributes = data['attributes']
       @relationships = data['relationships']
+      @included = included
+    end
+
+    def inspect
+      vars = %i[id attributes].map { |v| "#{v}=#{send(v).inspect}" }.join(', ')
+      vars << ", relationships={#{self.class.relationships.join(', ')}}"
+      "<#{self.class}: #{vars}>"
     end
   end
 end

data/lib/artemis_api/resource_unit.rb

@@ -0,0 +1,14 @@
+module ArtemisApi
+  class ResourceUnit < ArtemisApi::Model
+    json_type 'resource_units'
+    related_to_one :crop_variety
+
+    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/stage.rb

@@ -0,0 +1,15 @@
+module ArtemisApi
+  class Stage < ArtemisApi::Model
+    json_type 'stages'
+    related_to_many :sub_stages
+    related_to_many :zones
+
+    def self.find(id, facility_id, client, include: 'sub_stages,zones', 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: 'sub_stages,zones')
+      client.find_all(self.json_type, facility_id: facility_id, include: include)
+    end
+  end
+end

data/lib/artemis_api/sub_stage.rb

@@ -0,0 +1,5 @@
+module ArtemisApi
+  class SubStage < ArtemisApi::Model
+    json_type 'sub_stages'
+  end
+end

data/lib/artemis_api/subscription.rb

@@ -6,12 +6,12 @@ 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:)
-      client.oauth_token.refresh! if client.oauth_token.expired?
+      client.auto_refresh!
 
       url = "#{client.options[:base_uri]}/api/v3/facilities/#{facility_id}/subscriptions"
       params = { body: { subscription: { subject: subject, destination: destination } } }
@@ -22,7 +22,7 @@ module ArtemisApi
     end
 
     def self.delete(id:, facility_id:, client:)
-      client.oauth_token.refresh! if client.oauth_token.expired?
+      client.auto_refresh!
 
       url = "#{client.options[:base_uri]}/api/v3/facilities/#{facility_id}/subscriptions/#{id}"
 

data/lib/artemis_api/user.rb

@@ -5,7 +5,7 @@ module ArtemisApi
 
     def self.get_current(client:, include: nil)
       self.json_type
-      client.refresh if client.oauth_token.expired?
+      client.auto_refresh!
       url = "#{client.options[:base_uri]}/api/v3/user"
       url = "#{url}?include=#{include}" if include
       response = client.oauth_token.get(url)

data/lib/artemis_api/version.rb

@@ -1,3 +1,3 @@
 module ArtemisApi
-  VERSION = "0.2.0"
+  VERSION = '0.7.4'.freeze
 end

data/lib/artemis_api/zone.rb

@@ -1,6 +1,7 @@
 module ArtemisApi
   class Zone < ArtemisApi::Model
     json_type 'zones'
+    related_to_one 'sub_stage'
 
     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)

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,94 @@
+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)
+
+    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
+    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
+
+  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(',')
+
+    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
+  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/client_test.rb

@@ -0,0 +1,66 @@
+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_creating_a_client_instance_with_auth_code
+    stub_request(:post, 'http://localhost:3000/oauth/token')
+      .with(body: {"client_id"=>"12345",
+                    "client_secret"=>"67890",
+                    "code"=>"aJ7xsj7",
+                    "grant_type"=>"authorization_code",
+                    "redirect_uri"=>"urn:ietf:wg:oauth:2.0:oob"})
+      .to_return(status: 200, body: {access_token: 'ya29', refresh_token: 'eyJh', expires_in: 7200, token_type: 'Bearer', created_at: Time.now.to_i}.to_json, headers: { 'Content-Type'=> 'application/json;charset=UTF-8'})
+
+    options = {app_id: '12345',
+               app_secret: '67890',
+               base_uri: 'http://localhost:3000'}
+    @client = ArtemisApi::Client.new(auth_code: 'aJ7xsj7', options: options)
+
+    assert_equal '12345', @client.oauth_client.id
+    assert_equal 'ya29', @client.oauth_token.token
+    assert_equal false, @client.oauth_token.expired?
+  end
+
+  def test_creating_an_invalid_client_instance
+    assert_raises(ArgumentError) { ArtemisApi::Client.new(access_token: 'ya29') }
+  end
+
+  def test_current_user
+    get_client
+    stub_user
+
+    user = @client.current_user
+    assert_equal user.class, ArtemisApi::User
+  end
+
+  def test_remove_record
+    get_client
+
+    type = 'subscriptions'
+
+    # model type added once, removed twice
+    @client.store_record(type, 1, 'id' => 1)
+    assert_equal 1, @client.get_record(type, 1).id
+    @client.remove_record(type, 1)
+    assert_nil @client.get_record(type, 1)
+    assert_nothing_raised { @client.remove_record(type, 1) }
+
+    # model type not added, attempt to remove one
+    undefined_type = 'something'
+    assert_nil @client.instance_variable_get(:"@objects")[undefined_type]
+    assert_nothing_raised { @client.remove_record(undefined_type, 1) }
+  end
+end