fieldview 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05858ad578d5fc9f1a42d4f15c8d9ee0b7299f01
-  data.tar.gz: be48bc245a2c2a38c6b850b51f735ca4d8db193a
+  metadata.gz: 42ce3fc3ca592d38465e8625ab4ce76a19204ef3
+  data.tar.gz: 73bcdb8be3ae5e3f188f14e37233f9012536608a
 SHA512:
-  metadata.gz: d1893ef1af5bdcc6a9ca2790e9806d58828d24a859ad944109b611a1af556688a45761290f0694821a5690c44c3b3e86d59a69135178eec56bcad0598890997c
-  data.tar.gz: cad12cb23d33a5569cdd3583429bab951ede0d58c5fcc4ca6ea80e27266fff1554717d49edc4b28c76a4c5dfbaf2c7fc72507c5585e380d18e832f3f43866341
+  metadata.gz: 79d8559523948541f50ea3e826d163875013e30b3447285f1c948eefcf32a4371ff8e77689bf1137e45fe97e62f232af9913b1b24cc972cf2071268b3b2a7f05
+  data.tar.gz: 90b3f2a25cfdcaed05e9cb28a53737a24e2dab9b2f93eb9db159497472bf594d6783bcc21a87a84ce18f2b9f4adaa5fd6fdb1dfbc4c1e85f3fed9ceb69bca123

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fieldview (0.0.0)
+    fieldview (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -48,7 +48,7 @@ auth_token = FieldView::AuthToken.new(refresh_token: <RTOKEN>)
 
 # Then you can do something like this:
 
-fields = FieldView::Fields.list(auth_token)
+fields = FieldView::Field.list(auth_token)
 
 fields.each do |field|
     puts field.boundary
@@ -58,6 +58,30 @@ fields.has_more?
 
 ```
 
+## Uploading a File in Chunks
+
+Assuming you've acquired an AuthToken, then you can do something like the following:
+
+``` ruby
+file = <PATH TO SOME FILE>
+upload = FieldView::Upload.create(auth_token, 
+    Digest::MD5.file(file).to_s, File.size(file), 
+    <SOME FILE TYPE>)
+
+start_bytes = 0
+File.open(file, "rb") do|f|
+    response = nil
+    until f.eof?
+        # since it's 0 based
+        bytes = f.read(FieldView::Upload::REQUIRED_CHUNK_SIZE)
+        end_bytes = start_bytes + bytes.bytesize - 1
+        response = upload.upload_chunk(start_bytes, end_bytes, bytes)
+        puts "Uploaded #{start_bytes}-#{end_bytes}/#{File.size(file)}"
+        start_bytes = end_bytes + 1
+    end
+end
+```
+
 ## Development
 
 Run all tests:
@@ -70,7 +94,7 @@ Run a single test suite:
 
 Run a single test:
 
-    bundle exec ruby -Ilib/ test/field_view_test.rb -n /client.id/
+    bundle exec ruby -Ilib/ test/field_view_test.rb -n /requires_redirect_uri/
 
 ## TODOs
 

data/lib/fieldview/auth_token.rb

@@ -12,13 +12,21 @@ module FieldView
       # When the access token expires we'll need to refresh,
       # can be specified as part of the object, 14399 is what is being
       # returned at the time of writing this (2017-04-11)
-      self.access_token_expiration_at = params[:access_token_expiration_at] || (now + (params[:expires_in]||14399))
+      if params[:access_token_expiration_at].is_a?(String) then
+        self.access_token_expiration_at = Time.parse(params[:access_token_expiration_at])
+      else
+        self.access_token_expiration_at =  params[:access_token_expiration_at] || (now + (params[:expires_in]||14399))
+      end
 
       # Refresh token isn't required, but can be initialized with this
       self.refresh_token = params[:refresh_token]
 
       # Refresh token technically expires in 30 days
-      self.refresh_token_expiration_at = params[:access_token_expiration_at] || (now + (30)*24*60*60)
+      if params[:refresh_token_expiration_at].is_a?(String) then
+        self.refresh_token_expiration_at = Time.parse(params[:refresh_token_expiration_at])
+      else
+        self.refresh_token_expiration_at =  params[:refresh_token_expiration_at] || (now + (30)*24*60*60)
+      end
     end
 
     def access_token_expired?
@@ -106,7 +114,7 @@ module FieldView
     def self.new_auth_token_with_code_from_redirect_code(code, redirect_uri: nil)
       http, request = build_token_request([
         ["grant_type", "authorization_code"],
-        ["redirect_uri", FieldView.redirect_uri || redirect_uri],
+        ["redirect_uri", redirect_uri || FieldView.redirect_uri],
         ["code", code]
       ])
       response = http.request(request)

data/lib/fieldview/boundary.rb

@@ -1,20 +1,4 @@
 module FieldView
-  class Feature
-    attr_accessor :type, :coordinates
-    def initialize(json_feature_object)
-      # Use RGEO??
-      self.type = json_feature_object[:type]
-      self.coordinates = json_feature_object[:coordinates]
-    end
-
-    def point?()
-      return !!(self.type =~ /\Apoint\z/i)
-    end
-
-    def multi_polygon?()
-      return !!(self.type =~ /\Amultipolygon\z/i)
-    end
-  end
   class Boundary
     attr_accessor :id, :units, :area, :centroid, :geometry
     def initialize(json_object)

data/lib/fieldview/feature.rb

@@ -0,0 +1,24 @@
+module FieldView
+  class Feature
+    attr_accessor :type, :coordinates, :data
+
+    def initialize(json_feature_object)
+      # Use RGEO??
+      self.type = json_feature_object[:type]
+      self.coordinates = json_feature_object[:coordinates]
+      self.data = json_feature_object
+    end
+
+    def point?()
+      return !!(self.type =~ /\Apoint\z/i)
+    end
+
+    def multi_polygon?()
+      return !!(self.type =~ /\Amultipolygon\z/i)
+    end
+
+    def polygon?()
+      return !!(self.type =~ /\Apolygon\z/i)
+    end
+  end
+end

data/lib/fieldview/field.rb

@@ -1,5 +1,6 @@
 module FieldView
   class Field < Requestable
+    PATH = "fields"
     attr_accessor :id
     attr_accessor :name
     attr_accessor :boundary_id
@@ -10,6 +11,45 @@ module FieldView
       super(auth_token)
     end
 
+    def self.retrieve(auth_token, id)
+      response = auth_token.execute_request!(:get, "#{PATH}/#{id}")
+
+      Util.verify_response_with_code("Field retrieve", response, 200)
+
+      return new(response.data, auth_token)
+    end
+
+    def self.list(auth_token, limit: nil, next_token: nil)
+      limit ||= FieldView.default_page_limit
+      response = auth_token.execute_request!(:get, PATH,
+        headers: {
+          FieldView::NEXT_TOKEN_HEADER_KEY => next_token,
+          FieldView::PAGE_LIMIT_HEADER_KEY => limit
+          })
+      next_token = response.http_headers[FieldView::NEXT_TOKEN_HEADER_KEY]
+
+      if (response.http_status == 200 || response.http_status == 206) then
+        # 206: Partial result, will have more data
+        # 200: When all the results were in the list
+        return_data = response.data[:results]
+      elsif (response.http_status == 304)
+        # 304: Nothing modified since last request
+        return_data = []
+      else
+        # This should never happen
+        raise UnexpectedResponseError.new("Fields list expects 200,206, or 304 for codes",
+          fieldview_response: response)
+      end
+      
+      return ListObject.new(
+        self,
+        auth_token,
+        return_data.collect { |i| Field.new(i, auth_token) },
+        response.http_status,
+        next_token: next_token,
+        limit: limit)
+    end
+
     def boundary
       @boundary ||= nil
       if @boundary.nil?

data/lib/fieldview/list_object.rb

@@ -20,9 +20,8 @@ module FieldView
     def next_page!()
       return if !self.more_pages?()
       new_list = @listable.list(auth_token, limit: self.limit, next_token: self.next_token)
-      @data = new_list.data
-      @last_http_status = new_list.last_http_status
-      @auth_token = new_list.auth_token
+      initialize(new_list.listable, new_list.auth_token, 
+        new_list.data, new_list.last_http_status, next_token: new_list.next_token, limit: new_list.limit)
     end
 
     # alias for more_pages

data/lib/fieldview/util.rb

@@ -1,7 +1,7 @@
 module FieldView
   class Util
     def self.http_status_is_more_in_list?(http_status)
-      return http_status.to_i == 206
+      return http_status.nil? || http_status.to_i == 206
     end
 
     def self.verify_response_with_code(message, fieldview_response, *acceptable_response_codes)

data/lib/fieldview/version.rb

@@ -1,3 +1,3 @@
 module FieldView
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/fieldview.rb

@@ -8,9 +8,9 @@ require 'fieldview/version'
 
 # API Support Classes
 require 'fieldview/errors'
+require 'fieldview/feature'
 require 'fieldview/requestable'
 require 'fieldview/auth_token'
-require 'fieldview/fields'
 require 'fieldview/util'
 require 'fieldview/fieldview_response'
 require 'fieldview/field'

data/test/test_auth_token.rb

@@ -21,6 +21,20 @@ class TestAuthToken < Minitest::Test
     teardown_for_api_request
   end
 
+  def test_expiration_at_initialization
+    five_seconds_from_now = Time.now + 5
+    ten_seconds_from_now = Time.now + 10
+    token = FieldView::AuthToken.new(access_token: "yyy", refresh_access_token: "xxx",
+      access_token_expiration_at: five_seconds_from_now, refresh_token_expiration_at: ten_seconds_from_now)
+    assert_equal five_seconds_from_now, token.access_token_expiration_at
+    assert_equal ten_seconds_from_now, token.refresh_token_expiration_at
+
+    token = FieldView::AuthToken.new(access_token: "yyy", refresh_access_token: "xxx",
+      access_token_expiration_at: "2017-05-05T18:44:03.520-06:00", refresh_token_expiration_at: "2017-05-05T18:44:04.520-06:00")
+    assert_equal Time.parse("2017-05-05T18:44:03.520-06:00"), token.access_token_expiration_at
+    assert_equal Time.parse("2017-05-05T18:44:04.520-06:00"), token.refresh_token_expiration_at
+  end
+
   def test_build_token_request
     http, request = FieldView::AuthToken.build_token_request([["dont", "care"]])
     assert_equal "/api/oauth/token?dont=care", request.path

data/test/test_field.rb

@@ -2,15 +2,85 @@ require File.expand_path('../test_helper', __FILE__)
 
 class TestField < Minitest::Test
   FIXTURE = API_FIXTURES.fetch(:single_field_list)[:results][0]
-  def test_initialization
-    field = FieldView::Field.new(FIXTURE, new_auth_token)
+  LIST_FIXTURE = API_FIXTURES.fetch(:single_field_list)
+
+  def setup
+    setup_for_api_requests
+  end
   
+  def teardown
+    teardown_for_api_request
+  end
+
+  def test_retrieve()
+    stub_request(:get, /fields/).
+      to_return(status: 200, body: FIXTURE.to_json)
+
+    field = FieldView::Field.retrieve(new_auth_token, FIXTURE[:id])
+
     assert_equal FIXTURE[:id], field.id
     assert_equal FIXTURE[:name], field.name
     assert_equal FIXTURE[:boundaryId], field.boundary_id
     assert_equal new_auth_token.access_token, field.auth_token.access_token
   end
+  
+  def test_list_with_one_page()
+    next_token = "AZXJKLA123"
+    stub_request(:get, /fields/).
+      with(headers: { FieldView::PAGE_LIMIT_HEADER_KEY => FieldView.default_page_limit.to_s}).
+      to_return(status: 200, body: LIST_FIXTURE.to_json(),
+        headers: next_token_headers)
+    fields = FieldView::Field.list(new_auth_token)
+
+    assert_equal LIST_FIXTURE[:results].length, fields.data.length
+    assert_equal LIST_FIXTURE[:results][0][:id], fields.data[0].id
+    assert_equal next_token, fields.next_token
+    assert_equal FieldView::Field, fields.listable
+  end
+
+  def test_list_with_no_more_data
+    stub_request(:get, /fields/).
+      with(headers: { FieldView::PAGE_LIMIT_HEADER_KEY => FieldView.default_page_limit.to_s}).
+      to_return(status: 304, body: {}.to_json(),
+        headers: next_token_headers)
+    fields = FieldView::Field.list(new_auth_token)
+
+    assert_equal 0, fields.data.length
+  end
+
+  def test_with_more_data
+    next_token = "AZXJKLA123"
+    stub_request(:get, /fields/).
+      with(headers: { FieldView::PAGE_LIMIT_HEADER_KEY => FieldView.default_page_limit.to_s}).
+      to_return(status: 200, body: LIST_FIXTURE.to_json(),
+        headers: next_token_headers)
+    fields = FieldView::Field.list(new_auth_token)
+
+    assert_equal LIST_FIXTURE[:results].length, fields.data.length
+    assert_equal LIST_FIXTURE[:results][0][:id], fields.data[0].id
+    assert_equal next_token, fields.next_token
+  end
+
+  def test_with_limit
+    stub_request(:get, /fields/).
+      with(headers: { FieldView::PAGE_LIMIT_HEADER_KEY => 1}).
+      to_return(status: 200, body: LIST_FIXTURE.to_json(),
+        headers: next_token_headers)
+    fields = FieldView::Field.list(new_auth_token, limit: 1)
 
+    assert_equal 1, fields.data.length
+  end
+
+  def test_with_next_token
+    next_token = "AZXJKLA123"
+    stub_request(:get, /fields/).
+      with(headers: { FieldView::NEXT_TOKEN_HEADER_KEY => next_token }).
+      to_return(status: 200, body: LIST_FIXTURE.to_json())
+
+    fields = FieldView::Field.list(new_auth_token, next_token: next_token)
+    assert_equal 1, fields.data.length
+  end
+  
   def test_get_boundary
     field = FieldView::Field.new(FIXTURE, new_auth_token)
 

data/test/test_list_object.rb

@@ -2,19 +2,43 @@ require File.expand_path('../test_helper', __FILE__)
 
 class TestListObject < Minitest::Test
   FIXTURE = API_FIXTURES.fetch(:single_field_list)
-
+  
+  def setup
+    setup_for_api_requests
+  end
+  
+  def teardown
+    teardown_for_api_request
+  end
+  
   def test_each_loop
     data = ["x","y","z"]
-    list = FieldView::ListObject.new(FieldView::Fields, new_auth_token, data, 200, next_token: nil)
+    list = FieldView::ListObject.new(FieldView::Field, new_auth_token, data, 200, next_token: nil)
 
     list.each_with_index do |x, i|
       assert_equal data[i], x
     end
   end
 
+  def test_restart
+    next_token = "JZIOJKLJ"
+    old_next_token = "DONTCARE"
+    list = FieldView::ListObject.new(FieldView::Field, new_auth_token, 
+      ["dont","care"], 206, next_token: old_next_token)
+    stub_request(:get, /fields/).
+      to_return(status: 200, body: API_FIXTURES[:field_two_list].to_json(),
+        headers: next_token_headers(next_token))
+    
+    list.restart!
+    
+    assert_equal list.next_token, next_token
+    assert_equal list.last_http_status, 200
+    assert_equal API_FIXTURES[:field_two_list][:results][0][:id], list.data[0].id
+  end
+
   def test_get_next_page
     next_token = "JZIOJKLJ"
-    list = FieldView::ListObject.new(FieldView::Fields, new_auth_token, 
+    list = FieldView::ListObject.new(FieldView::Field, new_auth_token, 
       ["dont","care"], 206, next_token: next_token)
     stub_request(:get, /fields/).
       with(headers: next_token_headers(next_token)).
@@ -26,7 +50,7 @@ class TestListObject < Minitest::Test
     end
 
     assert_equal 1, list.data.length
-    assert_equal  API_FIXTURES[:field_two_list][:results][0][:id], list.data[0].id
+    assert_equal API_FIXTURES[:field_two_list][:results][0][:id], list.data[0].id
     assert !list.more_pages?()
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fieldview
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paul Susmarski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies: []
 description: ' FieldView is used to make data-driven decisions to maximize your return
   on every acre. This Ruby Gem is provided as a convenient way to access their API.'
@@ -28,8 +28,8 @@ files:
 - lib/fieldview/auth_token.rb
 - lib/fieldview/boundary.rb
 - lib/fieldview/errors.rb
+- lib/fieldview/feature.rb
 - lib/fieldview/field.rb
-- lib/fieldview/fields.rb
 - lib/fieldview/fieldview_response.rb
 - lib/fieldview/list_object.rb
 - lib/fieldview/requestable.rb
@@ -41,7 +41,6 @@ files:
 - test/test_auth_token.rb
 - test/test_boundary.rb
 - test/test_field.rb
-- test/test_fields.rb
 - test/test_fieldview.rb
 - test/test_helper.rb
 - test/test_list_object.rb
@@ -75,7 +74,6 @@ test_files:
 - test/test_auth_token.rb
 - test/test_boundary.rb
 - test/test_field.rb
-- test/test_fields.rb
 - test/test_fieldview.rb
 - test/test_helper.rb
 - test/test_list_object.rb

data/lib/fieldview/fields.rb

@@ -1,34 +0,0 @@
-module FieldView
-  class Fields
-    PATH = "fields"
-    def self.list(auth_token, limit: nil, next_token: nil)
-      limit ||= FieldView.default_page_limit
-      response = auth_token.execute_request!(:get, PATH,
-        headers: {
-          FieldView::NEXT_TOKEN_HEADER_KEY => next_token,
-          FieldView::PAGE_LIMIT_HEADER_KEY => limit
-          })
-      next_token = response.http_headers[FieldView::NEXT_TOKEN_HEADER_KEY]
-
-      if (response.http_status == 200 || response.http_status == 206) then
-        # 206: Partial result, will have more data
-        # 200: When all the results were in the list
-        return_data = response.data[:results]
-      elsif (response.http_status == 304)
-        # 304: Nothing modified since last request
-        return_data = []
-      else
-        # This should never happen
-        return_data = nil
-      end
-      
-      return ListObject.new(
-        self,
-        auth_token,
-        return_data.collect { |i| Field.new(i, auth_token) },
-        response.http_status,
-        next_token: next_token,
-        limit: limit)
-    end
-  end
-end

data/test/test_fields.rb

@@ -1,70 +0,0 @@
-require File.expand_path('../test_helper', __FILE__)
-
-class TestFields < Minitest::Test
-  FIXTURE = API_FIXTURES.fetch(:single_field_list)
-
-  def setup
-    setup_for_api_requests
-  end
-  
-  def teardown
-    teardown_for_api_request
-  end
-  
-  def test_list_with_one_page()
-    next_token = "AZXJKLA123"
-    stub_request(:get, /fields/).
-      with(headers: { FieldView::PAGE_LIMIT_HEADER_KEY => FieldView.default_page_limit.to_s}).
-      to_return(status: 200, body: FIXTURE.to_json(),
-        headers: next_token_headers)
-    fields = FieldView::Fields.list(new_auth_token)
-
-    assert_equal FIXTURE[:results].length, fields.data.length
-    assert_equal FIXTURE[:results][0][:id], fields.data[0].id
-    assert_equal next_token, fields.next_token
-    assert_equal FieldView::Fields, fields.listable
-  end
-
-  def test_list_with_no_more_data
-    stub_request(:get, /fields/).
-      with(headers: { FieldView::PAGE_LIMIT_HEADER_KEY => FieldView.default_page_limit.to_s}).
-      to_return(status: 304, body: {}.to_json(),
-        headers: next_token_headers)
-    fields = FieldView::Fields.list(new_auth_token)
-
-    assert_equal 0, fields.data.length
-  end
-
-  def test_with_more_data
-    next_token = "AZXJKLA123"
-    stub_request(:get, /fields/).
-      with(headers: { FieldView::PAGE_LIMIT_HEADER_KEY => FieldView.default_page_limit.to_s}).
-      to_return(status: 200, body: FIXTURE.to_json(),
-        headers: next_token_headers)
-    fields = FieldView::Fields.list(new_auth_token)
-
-    assert_equal FIXTURE[:results].length, fields.data.length
-    assert_equal FIXTURE[:results][0][:id], fields.data[0].id
-    assert_equal next_token, fields.next_token
-  end
-
-  def test_with_limit
-    stub_request(:get, /fields/).
-      with(headers: { FieldView::PAGE_LIMIT_HEADER_KEY => 1}).
-      to_return(status: 200, body: FIXTURE.to_json(),
-        headers: next_token_headers)
-    fields = FieldView::Fields.list(new_auth_token, limit: 1)
-
-    assert_equal 1, fields.data.length
-  end
-
-  def test_with_next_token
-    next_token = "AZXJKLA123"
-    stub_request(:get, /fields/).
-      with(headers: { FieldView::NEXT_TOKEN_HEADER_KEY => next_token }).
-      to_return(status: 200, body: FIXTURE.to_json())
-
-    fields = FieldView::Fields.list(new_auth_token, next_token: next_token)
-    assert_equal 1, fields.data.length
-  end
-end