myjohndeere 0.0.1

data/test/api_fixtures.rb

@@ -0,0 +1,29 @@
+class APIFixtures
+  def initialize
+    @fixtures = ::JSON.parse(File.read("#{PROJECT_ROOT}/spec/fixtures.json"))
+    freeze_recursively(@fixtures)
+  end
+
+  def [](name)
+    @fixtures[name]
+  end
+
+  def fetch(*args)
+    @fixtures.fetch(*args)
+  end
+
+  def generate_json(name)
+    JSON.generate(self.fetch(name))
+  end
+
+  private
+
+  def freeze_recursively(data)
+    data.each do |k, v|
+      if v.is_a?(Hash)
+        freeze_recursively(v)
+      end
+    end
+    data.freeze
+  end
+end

data/test/test_access_token.rb

@@ -0,0 +1,60 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestAccessToken < Minitest::Test
+  def test_get_request_token
+    expected_secret = "v8gWA1cxT1Gfx1nkxi01R8xy6uHbMLw/9cMzYTl9bqqTPJWQkRpZr5WmMQA0S4clamix2tGMD5rlfvXis7DxGKcxA6ZIMGXLK1mMOegnM78="
+    expected_token = "12ac3ff0-a13e-4c61-83f4-5cf9bd532341"
+
+    stub_request(:get, "#{MyJohnDeere.configuration.endpoint}/oauth/request_token").
+      to_return(status: 200, body: "oauth_token=#{expected_token}&oauth_token_secret=#{expected_secret}&oauth_callback_confirmed=true")
+    rt = MyJohnDeere::AccessToken.get_request_token()
+
+    assert_equal expected_token, rt.token
+    assert_equal expected_secret, rt.secret
+  end
+
+  def test_initialize_without_exact_options
+    assert_raises ArgumentError do
+      MyJohnDeere::AccessToken.new()
+    end
+  end
+
+  def test_initialize_access_token_with_request_token
+    expected_secret = "1Of2eWDVM2x90j1kjxVgxlz091kjmnndsa0912FYwz7ZxlVgPcPmFGb1RtBWLXGVw3k"
+    expected_token = "2f05ab26-1879-4bfe-9129-b9b0144d1610"
+    
+    stub_request(:post, "#{MyJohnDeere.configuration.endpoint}/oauth/access_token").
+      to_return(status: 200, body: "oauth_token=#{expected_token}&oauth_token_secret=#{expected_secret}", headers: {})
+    at = MyJohnDeere::AccessToken.new(
+      request_token_token: "12ac3ff0-a13e-4c61-83f4-5cf9bd532341",
+      request_token_secret: "v8gWA1cxT1Gfx1nkxi01R8xy6uHbMLw/9cMzYTl9bqqTPJWQkRpZr5WmMQA0S4clamix2tGMD5rlfvXis7DxGKcxA6ZIMGXLK1mMOegnM78=",
+      verifier_code: "blah"
+    )
+
+    assert_equal expected_token, at.token
+    assert_equal expected_secret, at.secret
+  end
+
+  def test_initialize_access_token_with_access_token_options
+    expected_secret = "1Of2eWDVM2x90j1kjxVgxlz091kjmnndsa0912FYwz7ZxlVgPcPmFGb1RtBWLXGVw3k"
+    expected_token = "2f05ab26-1879-4bfe-9129-b9b0144d1610"
+    
+    at = MyJohnDeere::AccessToken.new(
+      oauth_access_token_token: expected_token,
+      oauth_access_token_secret: expected_secret,
+    )
+    assert_equal expected_token, at.token
+    assert_equal expected_secret, at.secret
+  end
+
+  def test_send_get_request
+    at = default_access_token()
+    expected_json = API_FIXTURES.fetch("api_catalog")
+    stub_request(:get, "https://sandboxapi.deere.com/platform/").
+      to_return(status: 200, body: JSON.generate(expected_json), headers: {})
+
+    response = at.execute_request(:get, "/")
+    assert_equal 200, response.http_status
+    assert_equal expected_json.to_json, response.data.to_json
+  end
+end

data/test/test_boundary.rb

@@ -0,0 +1,37 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestBoundary < Minitest::Test
+  FIXTURE = API_FIXTURES.fetch("boundary")
+  FIXTURE_FOR_LIST = API_FIXTURES.fetch("boundaries")
+  ORGANIZATION_FIXTURE = API_FIXTURES.fetch("organization")
+
+  def test_retrieve()
+    expected_organization_id = ORGANIZATION_FIXTURE["id"]
+    expected_boundary_id = FIXTURE["id"]
+    stub_request(:get, /\/organizations\/#{expected_organization_id}\/boundaries\/#{expected_boundary_id}/).
+      to_return(status: 200, body: FIXTURE.to_json)
+
+    boundary = MyJohnDeere::Boundary.retrieve(default_access_token, 
+      expected_boundary_id, organization_id: expected_organization_id)
+
+    assert_equal expected_boundary_id, boundary.id
+    assert_equal expected_organization_id, boundary.organization_id
+    assert_nil boundary.field_id
+    assert_equal true, boundary.active
+    assert_equal "2/25/2015 6:01:19 PM", boundary.name
+    assert_equal 1, boundary.multipolygons.length
+  end
+
+  def test_list
+    organization_id = "1234"
+    field_id = "6232611a-0303-0234-8g7d-e1e1e11871b8"
+    stub_request(:get, /organizations\/#{organization_id}\/fields\/#{field_id}\/boundaries/).
+      to_return(status: 200, body: FIXTURE_FOR_LIST.to_json)
+
+    boundaries = MyJohnDeere::Boundary.list(default_access_token, count: 1, 
+      organization_id: organization_id, field_id: field_id)
+
+    assert_equal 1, boundaries.data.length
+    assert_equal MyJohnDeere::Boundary, boundaries.data[0].class
+  end
+end

data/test/test_field.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestField < Minitest::Test
+  FIXTURE = API_FIXTURES.fetch("field")
+  FIXTURE_FOR_LIST = API_FIXTURES.fetch("fields")
+  ORGANIZATION_FIXTURE = API_FIXTURES["organization"]
+
+  def test_retrieve()
+    expected_organization_id = ORGANIZATION_FIXTURE["id"]
+    expected_field_id = FIXTURE["id"]
+    stub_request(:get, /\/organizations\/#{expected_organization_id}\/fields\/#{expected_field_id}/).
+      to_return(status: 200, body: FIXTURE.to_json)
+
+    field = MyJohnDeere::Field.retrieve(default_access_token, 
+      expected_field_id, organization_id: expected_organization_id)
+
+    assert_equal expected_field_id, field.id
+    assert_equal expected_organization_id, field.organization_id
+    assert_equal "Nautilus", field.name
+    assert_equal FIXTURE["links"].length, field.links.length
+  end
+
+  def test_retrieve_with_embedded_boudnary
+    fixture = API_FIXTURES["field_with_embedded_boundary"]
+    stub_request(:get, /\/organizations\/#{ORGANIZATION_FIXTURE["id"]}\/fields\/#{fixture["id"]}/).
+      with(query: {embed: "boundaries"}).
+      to_return(status: 200, body: fixture.to_json)
+
+    field = MyJohnDeere::Field.retrieve(default_access_token, 
+      fixture["id"], organization_id: ORGANIZATION_FIXTURE["id"],
+      body: {embed: "boundaries"})
+
+    assert field.instance_variable_get(:@boundary)
+    assert_equal fixture["boundaries"][0]["id"], field.boundary.id
+    assert_equal field.id, field.boundary.field_id
+  end
+
+  def test_list()
+    stub_request(:get, /organizations\/#{ORGANIZATION_FIXTURE["id"]}\/fields/).
+      to_return(status: 200, body: FIXTURE_FOR_LIST.to_json)
+
+    fields = MyJohnDeere::Field.list(default_access_token, count: 1, organization_id: ORGANIZATION_FIXTURE["id"])
+
+    assert_equal 1, fields.data.length
+    assert_equal MyJohnDeere::Field, fields.data[0].class
+  end
+end

data/test/test_file_resource.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestFileResource < Minitest::Test
+  FIXTURE = API_FIXTURES.fetch("file_resource")
+  FIXTURE_FOR_LIST = API_FIXTURES.fetch("file_resources")
+  FILE_RESOURCE_ID = FIXTURE["id"]
+  ORGANIZATION_ID = "1234"
+  MAP_LAYER_ID = "83ks9gh3-29fj-9302-837j-92jlsk92jd095kd"
+
+  def test_retrieve()
+    stub_request(:get, /\/fileResources\/#{FILE_RESOURCE_ID}/).
+      to_return(status: 200, body: FIXTURE.to_json)
+
+    file_resource = MyJohnDeere::FileResource.retrieve(default_access_token, FILE_RESOURCE_ID)
+    assert_equal FILE_RESOURCE_ID, file_resource.id
+    assert_equal ORGANIZATION_ID, file_resource.organization_id
+    assert_equal "image/png", file_resource.mime_type
+    assert_equal [{"name"=>"The Name", "value"=>"The Value"}], file_resource.metadata
+    assert_equal Time, file_resource.timestamp.class
+  end
+
+  def test_list
+    stub_request(:get, /mapLayers\/#{MAP_LAYER_ID}\/fileResources/).
+      to_return(status: 200, body: FIXTURE_FOR_LIST.to_json)
+
+    file_resources = MyJohnDeere::FileResource.list(default_access_token, count: 1, 
+      map_layer_id: MAP_LAYER_ID)
+
+    assert_equal 1, file_resources.data.length
+    assert_equal MyJohnDeere::FileResource, file_resources.data[0].class
+  end
+
+  def test_create
+    expected_body = "{\"links\":[{\"rel\":\"owningOrganization\",\"uri\":\"https://sandboxapi.deere.com/platform/organizations/1234\"}],\"mimeType\":\"application/zip\",\"metadata\":[{\"key\":\"key\",\"value\":\"value\"}]}"
+    stub_request(:post, /mapLayers\/#{MAP_LAYER_ID}\/fileResources/).
+      with(body: expected_body,
+       headers: {'Accept'=>'application/vnd.deere.axiom.v3+json', 'Content-Length'=>expected_body.length, 'Content-Type'=>'application/vnd.deere.axiom.v3+json'}).
+      to_return(status: 201, headers: {"Location"=>"https://sandboxapi.deere.com/platform/fileResources/#{MAP_LAYER_ID}"})
+    response = MyJohnDeere::FileResource.create(default_access_token, 
+      ORGANIZATION_ID,
+      MAP_LAYER_ID,
+      file_type: :zip,
+      metadata: [MyJohnDeere::MetadataItem.new("key", "value")]
+    )
+    assert_equal MAP_LAYER_ID, response.id
+    assert_equal ORGANIZATION_ID, response.organization_id
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+require 'myjohndeere'
+require 'byebug'
+require 'webmock/minitest'
+
+PROJECT_ROOT = File.expand_path("../../", __FILE__)
+require File.expand_path('../api_fixtures', __FILE__)
+
+class Minitest::Test
+  # Fixtures are available in tests using something like:
+  #
+  #   API_FIXTURES[:fields][:id]
+  #
+  API_FIXTURES = APIFixtures.new
+
+  def setup
+    MyJohnDeere.configure do |config|
+      config.app_id = "Dontcare"
+      config.shared_secret = "somesecret"
+      config.environment = :sandbox
+      config.contribution_definition_id = "foobar"
+      #config.log_level = :info
+    end
+  end
+
+  def teardown
+    WebMock.reset!
+  end
+
+  def default_access_token
+    MyJohnDeere::AccessToken.new(
+      oauth_access_token_token: "1Of2eWDVM2x90j1kjxVgxlz091kjmnndsa0912FYwz7ZxlVgPcPmFGb1RtBWLXGVw3k",
+      oauth_access_token_secret: "2f05ab26-1879-4bfe-9129-b9b0144d1610",
+    )
+  end
+end

data/test/test_list_object.rb

@@ -0,0 +1,74 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestListObject < Minitest::Test
+  def test_each_loop
+    data = Array.new(3, API_FIXTURES["organization"])
+    list = MyJohnDeere::ListObject.new(MyJohnDeere::Organization, 
+      default_access_token, 
+      {"values" => data})
+
+    list.each_with_index do |x, i|
+      assert_equal data[i]["id"], x.id
+    end
+
+    assert_equal data.length, list.total
+  end
+
+  def test_has_more
+    expected_total = 3
+    list = MyJohnDeere::ListObject.new(MyJohnDeere::Organization,
+      default_access_token, {
+        "total" => expected_total,
+        "values" => Array.new(1, API_FIXTURES["organization"])
+      }, options: {start: 0})
+    assert list.has_more?
+
+    list.start = expected_total
+    assert !list.has_more?
+
+    list = MyJohnDeere::ListObject.new(MyJohnDeere::Organization,
+      default_access_token, {"values" =>[]}, options: {start: 0})
+    assert !list.has_more?, "The data is equal to the total"
+  end
+
+  def test_get_next_page_with_etag
+    # etag behavior gets the entire list.
+    test_json = API_FIXTURES["organizations"]
+    existing_data = Array.new(test_json["total"]-1, test_json["values"][0])
+    list = MyJohnDeere::ListObject.new(MyJohnDeere::Organization, default_access_token, 
+      {"values" => existing_data}, options: {
+        start: 0, count: existing_data.length, etag: ""})
+    assert list.using_etag?
+    assert !list.has_more?
+    assert_equal list.data.length, list.data.length
+    assert_equal 0, list.start
+
+    # Validate that the etag header is getting propagated to the next request
+    list.next_page!()
+
+    assert_equal list.data.length, list.data.length, "shouldn't have changed"
+    assert_equal 0, list.start, "shouldn't have changed"
+  end
+
+  def test_get_next_page
+    test_json = API_FIXTURES["organizations"]
+    existing_data = (1..(test_json["total"]-1)).to_a
+    list = MyJohnDeere::ListObject.new(MyJohnDeere::Organization, default_access_token, 
+      test_json, options: {start: 0,
+      count: existing_data.length})
+    assert list.has_more?
+    assert !list.using_etag?
+
+    # Validate that the etag header is getting propagated to the next request
+    stub_request(:get, /organizations;start=#{existing_data.count};count=#{existing_data.count}/).
+      with(headers: {'Accept'=>'application/vnd.deere.axiom.v3+json'}).
+      to_return(status: 200, body: test_json.to_json())
+
+    list.next_page!()
+
+    assert_equal 1, list.data.length
+    assert_equal existing_data.length, list.start
+    assert_equal test_json["values"].first["id"], list.data.first.id
+    assert !list.has_more?()
+  end
+end

data/test/test_map_layer.rb

@@ -0,0 +1,52 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestMapLayer < Minitest::Test
+  FIXTURE = API_FIXTURES.fetch("map_layer")
+  FIXTURE_FOR_LIST = API_FIXTURES.fetch("map_layers")
+  ORGANIZATION_ID = "1234"
+  MAP_LAYER_ID = "83ks9gh3-29fj-9302-837j-92jlsk92jd095kd"
+  MLS_ID = "2516aa2c-1c0d-4dae-ba63-5c44ff172a01"
+  FIELD_ID = "2516aa2c-2c0d-4dae-ba63-5c44ff172a01"
+
+  def test_retrieve()
+    stub_request(:get, /\/mapLayers\/#{FIXTURE["id"]}/).
+      to_return(status: 200, body: FIXTURE.to_json)
+
+    ml = MyJohnDeere::MapLayer.retrieve(default_access_token, FIXTURE["id"])
+    assert_equal MAP_LAYER_ID, ml.id
+    assert_equal ORGANIZATION_ID, ml.organization_id
+    assert_equal "The title on the map layer", ml.title
+    assert_equal 4, ml.extent.length
+    assert_equal "seeds1ha-1", ml.legends["unitId"]
+    assert_equal 1, ml.legends["ranges"].length
+    assert_equal MyJohnDeere::MapLegendItem, ml.legends["ranges"][0].class, "Should be a map legend item"
+    assert_equal({:label=>"Some Label", :minimum=>87300, :maximum=>87300, :hexColor=>"#0BA74A", :percent=>0.13},
+      ml.legends["ranges"][0].to_hash)
+  end
+
+  def test_list
+    stub_request(:get, /mapLayerSummaries\/#{MLS_ID}\/mapLayers/).
+      to_return(status: 200, body: FIXTURE_FOR_LIST.to_json)
+
+    map_layers = MyJohnDeere::MapLayer.list(default_access_token, count: 1, 
+      map_layer_summary_id: MLS_ID)
+
+    assert_equal 1, map_layers.data.length
+    assert_equal MyJohnDeere::MapLayer, map_layers.data[0].class
+  end
+
+  def test_create
+    expected_body = "{\"links\":[{\"rel\":\"owningOrganization\",\"uri\":\"https://sandboxapi.deere.com/platform/organizations/1234\"}],\"title\":\"The title on the map layer\",\"extent\":{\"minimumLatitude\":0,\"maximumLatitude\":1,\"minimumLongitude\":0,\"maximumLongitude\":1},\"legends\":{\"unitId\":\"foo\",\"ranges\":[{\"label\":\"bar\",\"minimum\":1,\"maximum\":2,\"hexColor\":\"#0BA74A\",\"percent\":15.0}]}}"
+    stub_request(:post, /mapLayerSummaries\/#{MLS_ID}\/mapLayers/).
+      with(body: expected_body,
+       headers: {'Accept'=>'application/vnd.deere.axiom.v3+json', 'Content-Length'=>expected_body.length, 'Content-Type'=>'application/vnd.deere.axiom.v3+json'}).
+      to_return(status: 201, headers: {"Location"=>"https://sandboxapi.deere.com/platform/mapLayers/#{MAP_LAYER_ID}"})
+    response = MyJohnDeere::MapLayer.create(default_access_token, 
+      MLS_ID,
+      ORGANIZATION_ID,
+      minimum_latitude: 0, minimum_longitude: 0, maximum_latitude: 1, maximum_longitude: 1,
+      map_layer_id: "foo", map_legend_items: [MyJohnDeere::MapLegendItem.new("bar", 1, 2, "#0BA74A", 15.0)]
+    )
+    assert_equal MAP_LAYER_ID, response
+  end
+end

data/test/test_map_layer_summary.rb

@@ -0,0 +1,52 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestMapLayerSummary < Minitest::Test
+  FIXTURE = API_FIXTURES.fetch("map_layer_summary")
+  FIXTURE_FOR_LIST = API_FIXTURES.fetch("map_layer_summaries")
+  ORGANIZATION_ID = "1234"
+  MLS_ID = "2516aa2c-1c0d-4dae-ba63-5c44ff172a01"
+  FIELD_ID = "2516aa2c-2c0d-4dae-ba63-5c44ff172a01"
+
+  def test_retrieve()
+    stub_request(:get, /\/mapLayerSummaries\/#{FIXTURE["id"]}/).
+      to_return(status: 200, body: FIXTURE.to_json)
+
+    mls = MyJohnDeere::MapLayerSummary.retrieve(default_access_token, FIXTURE["id"])
+    assert_equal MLS_ID, mls.id
+    assert_equal ORGANIZATION_ID, mls.organization_id
+    assert_equal "some title", mls.title
+    assert_equal "description of the map layers", mls.text
+    assert_equal [{"name"=>"The Name", "value"=>"The Value"}], mls.metadata
+    assert_equal Time, mls.date_created.class
+    assert_equal Time, mls.last_modified_date.class
+  end
+
+  def test_list
+    stub_request(:get, /organizations\/#{ORGANIZATION_ID}\/fields\/#{FIELD_ID}\/mapLayerSummaries/).
+      to_return(status: 200, body: FIXTURE_FOR_LIST.to_json)
+
+    mlss = MyJohnDeere::MapLayerSummary.list(default_access_token, count: 1, 
+      organization_id: ORGANIZATION_ID, field_id: FIELD_ID)
+
+    assert_equal 1, mlss.data.length
+    assert_equal MyJohnDeere::MapLayerSummary, mlss.data[0].class
+  end
+
+  def test_create
+    expected_body = "{\"title\":\"Test number 2\",\"text\":\"Hello from farm lens again\",\"links\":[{\"rel\":\"owningOrganization\",\"uri\":\"https://sandboxapi.deere.com/platform/organizations/1234\"},{\"rel\":\"contributionDefinition\",\"uri\":\"https://sandboxapi.deere.com/platform/foobar\"}],\"metadata\":[{\"key\":\"key\",\"value\":\"val\"}],\"dateCreated\":\"2016-01-02T16:14:23.421Z\"}"
+    stub_request(:post, /\/organizations\/#{ORGANIZATION_ID}\/fields\/#{FIELD_ID}\/mapLayerSummaries/).
+      with(body: expected_body,
+       headers: {'Accept'=>'application/vnd.deere.axiom.v3+json', 'Content-Length'=>expected_body.length, 'Content-Type'=>'application/vnd.deere.axiom.v3+json'}).
+      to_return(status: 201, headers: {"Location"=>"https://sandboxapi.deere.com/platform/mapLayerSummaries/#{MLS_ID}"})
+    response = MyJohnDeere::MapLayerSummary.create(default_access_token, 
+      ORGANIZATION_ID,
+      FIELD_ID,
+      "Test number 2",
+      "Hello from farm lens again",
+      [MyJohnDeere::MetadataItem.new("key", "val")],
+      Time.parse("2016-01-02T16:14:23.421Z")
+    )
+    assert_equal MLS_ID, response.id
+    assert_equal ORGANIZATION_ID, response.organization_id
+  end
+end