fieldview 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c291877633d7f4126668164ee7cc60c7c5c67bac
-  data.tar.gz: df16497405345a46fab2c65066eec659ffc074b7
+  metadata.gz: 05858ad578d5fc9f1a42d4f15c8d9ee0b7299f01
+  data.tar.gz: be48bc245a2c2a38c6b850b51f735ca4d8db193a
 SHA512:
-  metadata.gz: 883b9f63fcaf3af60958bc8407660a76608afca697fa043afae906240d6c7f2f36ed3116dea2de6c76630c3e4ba82effe08d6d11ab3e349c4cb03b962eae052d
-  data.tar.gz: 8d027e67cdabf34fd66a7284196c34533d82b2f002df8826b2d91b8005ae4246fb8632225f5b67041dd518c465a4826244f5e5eabc9e7a2d6927acb91d63808d
+  metadata.gz: d1893ef1af5bdcc6a9ca2790e9806d58828d24a859ad944109b611a1af556688a45761290f0694821a5690c44c3b3e86d59a69135178eec56bcad0598890997c
+  data.tar.gz: cad12cb23d33a5569cdd3583429bab951ede0d58c5fcc4ca6ea80e27266fff1554717d49edc4b28c76a4c5dfbaf2c7fc72507c5585e380d18e832f3f43866341

data/Gemfile.lock

@@ -2,7 +2,6 @@ PATH
   remote: .
   specs:
     fieldview (0.0.0)
-      faraday (~> 0.9)
 
 GEM
   remote: https://rubygems.org/
@@ -12,11 +11,8 @@ GEM
     byebug (9.0.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    faraday (0.12.0.1)
-      multipart-post (>= 1.2, < 3)
     hashdiff (0.3.2)
     minitest (5.8.4)
-    multipart-post (2.0.0)
     public_suffix (2.0.5)
     rake (11.3.0)
     safe_yaml (1.0.4)

data/README.md

@@ -2,6 +2,16 @@
 
 The FieldView Ruby library provides convenient access to the FieldView API from applications written in the Ruby language. It includes a pre-defined set of classes for API resources that are available currently from the API. You will need to get access from a Climate Corporation representative and the interface utilize OAUTH 2.0.
 
+OAuth token refreshing is handled for your if for some reason the token expires in the middle of requests (this requires that you provide the `refresh_token` with the creation of the `AuthToken`).
+
+## Listable Objects
+
+FieldView returns pages of objects that are tracked via the headers, you cannot go back in pages easily (perhaps we could be tracking the next-token?). Use `more_pages?` on the listable object to see if there are more pages to be acquired by using `next_page!`. The `next_token` on listable objects can also be preserved when reaching the end of a list to see if there are any additional changes since the `next_token` was saved.
+
+The raw data can be acquired by using `.data` on a listable object.
+
+When finished you will want to store information of the `AuthToken` somewhere as it may have changed with requests.
+
 ## Usage
 
 The library needs to be configured with your FieldView account's client secret,
@@ -25,9 +35,10 @@ auth_token = FieldView::AuthToken.new_auth_token_with_code_from_redirect_code(<C
 # Or initialize with previous information
 auth_token = FieldView::AuthToken.new(
     access_token: <ATOKEN>, 
-    expiration_at: <DATETIME>,
+    expiration_at: <DATETIME>, # not required, but should be known
     refresh_token: <RTOKEN>,
-    refresh_token_expiration_at: <DATETIME>)
+    refresh_token_expiration_at: <DATETIME> # Not required, but should be known
+)
 
 # Or with just auth_token (assuming it hasn't expired)
 auth_token = FieldView::AuthToken.new(access_token: <ATOKEN>)
@@ -35,6 +46,15 @@ auth_token = FieldView::AuthToken.new(access_token: <ATOKEN>)
 # refresh token and a new access/refresh token will be associated with the object
 auth_token = FieldView::AuthToken.new(refresh_token: <RTOKEN>) 
 
+# Then you can do something like this:
+
+fields = FieldView::Fields.list(auth_token)
+
+fields.each do |field|
+    puts field.boundary
+end
+
+fields.has_more?
 
 ```
 
@@ -52,6 +72,13 @@ Run a single test:
 
     bundle exec ruby -Ilib/ test/field_view_test.rb -n /client.id/
 
+## TODOs
+
+- [ ] Thread safety of the auth token object since it's passed to all created objects
+- [ ] Probably add configurable behavior for auto-refresh
+- [ ] Change the configuration to non-static variables (at least the items that are required)
+- [ ] Use faraday so that we are middleware agnostic
+
 ## Disclaimer
 
 This Gem is in no way associated with The Climate Corporation, and they are in no way associated with it's support, maintenance, or updates.

data/fieldview.gemspec

@@ -1,18 +1,18 @@
 $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
+require 'fieldview/version'
+
 spec = Gem::Specification.new do |s|
   s.name = 'fieldview'
-  s.version = "0.0.0"
+  s.version = FieldView::VERSION
   s.required_ruby_version = '>= 1.9.3'
   s.summary = 'Ruby bindings for the FieldView API'
-  s.description = ' FieldView is used make data-driven decisions to maximize your return on every acre.'
+  s.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.'
   s.author = 'Paul Susmarski'
   s.email = 'paul@susmarski.com'
   s.homepage = 'http://rubygems.org/gems/fielview'
   s.license = 'MIT'
 
-  s.add_dependency('faraday', '~> 0.9')
-
   s.files = Dir['lib/**/*.rb']
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

data/lib/fieldview/auth_token.rb

@@ -12,14 +12,13 @@ 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) - 10)
+      self.access_token_expiration_at = params[:access_token_expiration_at] || (now + (params[:expires_in]||14399))
 
       # Refresh token isn't required, but can be initialized with this
       self.refresh_token = params[:refresh_token]
 
-      # Refresh token technically expires in 30 days, but
-      # we'll subtract one day for safety
-      self.refresh_token_expiration_at = params[:access_token_expiration_at] || (now + (30-1)*24*60*60)
+      # Refresh token technically expires in 30 days
+      self.refresh_token_expiration_at = params[:access_token_expiration_at] || (now + (30)*24*60*60)
     end
 
     def access_token_expired?
@@ -61,15 +60,27 @@ module FieldView
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = FieldView.api_base.start_with?("https")
       request = Net::HTTP.class_eval(method.to_s.capitalize).new(uri.request_uri)
+      if method == :get then
+        new_query_ar = URI.decode_www_form(uri.query || '') 
+        params.each do |key,value|
+          new_query_ar << [key.to_s, value.to_s]
+        end
+        uri.query = URI.encode_www_form(new_query_ar)
+        request = Net::HTTP.class_eval(method.to_s.capitalize).new(uri.request_uri)
+      else
+        if params.is_a?(Hash)
+          request.body = params.to_json()
+        else
+          request.body = params
+        end
+      end
       request["Accept"] = "*/*"
       request["Authorization"] = "Bearer #{self.access_token}"
       request["X-Api-Key"] = FieldView.x_api_key
       request["Content-Type"] = "application/json"
-      
       headers.each do |header,value|
         request[header] = value.to_s
       end
-
       response = http.request(request)
       FieldView.handle_response_error_codes(response)
       return FieldViewResponse.new(response)
@@ -92,10 +103,10 @@ module FieldView
     end
 
     # Code will be collected from the redirect to your server
-    def self.new_auth_token_with_code_from_redirect_code(code)
+    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", FieldView.redirect_uri || redirect_uri],
         ["code", code]
       ])
       response = http.request(request)
@@ -107,5 +118,12 @@ module FieldView
         return AuthToken.new(json)
       end
     end
+
+    def to_s()
+      [
+        "AccessToken: #{self.access_token}, Expiration: #{self.access_token_expiration_at}",
+        "RefreshToken: #{self.refresh_token}, Expiration: #{self.refresh_token_expiration_at}"
+      ].join('\n')
+    end
   end
 end

data/lib/fieldview/errors.rb

@@ -14,8 +14,14 @@ module FieldView
     attr_accessor :response
     # Initializes a FieldViewError.
     def initialize(message=nil, http_status: nil, http_body: nil,
-                   http_headers: nil)
+                   http_headers: nil, fieldview_response: nil)
       @message = message
+      if fieldview_response then
+        self.response = fieldview_response
+        http_status = fieldview_response.http_status
+        http_body = fieldview_response.http_body
+        http_headers = fieldview_response.http_headers
+      end
       @http_status = http_status
       @http_body = http_body
       @http_headers = http_headers || {}
@@ -61,4 +67,10 @@ module FieldView
   # Raised when the server is busy
   class ServerBusyError < FieldViewError
   end
+
+  # Raised when a response code that is non-breaking is outside
+  # API specifications, ex: We expect a 201 when creating an upload, but it
+  # returns a 200
+  class UnexpectedResponseError < FieldViewError
+  end
 end

data/lib/fieldview/field.rb

@@ -1,14 +1,13 @@
 module FieldView
-  class Field
+  class Field < Requestable
     attr_accessor :id
     attr_accessor :name
     attr_accessor :boundary_id
-    attr_accessor :auth_token
     def initialize(json_object, auth_token = nil)
       self.id = json_object[:id]
       self.name = json_object[:name]
       self.boundary_id = json_object[:boundaryId]
-      self.auth_token = auth_token
+      super(auth_token)
     end
 
     def boundary

data/lib/fieldview/fieldview_response.rb

@@ -12,9 +12,13 @@ module FieldView
       end
       
       self.http_body = response.body
-      begin
-        self.data = JSON.parse(response.body, symbolize_names: true)
-      rescue JSON::ParserError
+      if response.body then
+        begin
+          self.data = JSON.parse(response.body, symbolize_names: true)
+        rescue JSON::ParserError
+          self.data = nil
+        end
+      else
         self.data = nil
       end
       self.http_status = response.code.to_i

data/lib/fieldview/list_object.rb

@@ -1,16 +1,16 @@
 module FieldView
-  class ListObject
+  class ListObject < Requestable
     attr_accessor :limit
-    attr_reader :auth_token, :data, :last_http_status, :next_token, :listable
+    attr_reader :data, :last_http_status, :next_token, :listable
     include Enumerable
 
     def initialize(listable, auth_token, data, http_status, next_token: nil, limit: 100)
       @listable = listable
-      @auth_token = auth_token
       @data = data
       @last_http_status = http_status
       @next_token = next_token
       @limit = 100
+      super(auth_token)
     end
 
     def each(&blk)

data/lib/fieldview/requestable.rb

@@ -0,0 +1,9 @@
+module FieldView
+  class Requestable
+    attr_accessor :auth_token
+
+    def initialize(auth_token = nil)
+      self.auth_token = auth_token
+    end
+  end
+end

data/lib/fieldview/upload.rb

@@ -0,0 +1,62 @@
+module FieldView
+  class Upload < Requestable
+    # 5 Megabytes is the current chunk size
+    REQUIRED_CHUNK_SIZE = 5*1024*1024
+    CHUNK_CONTENT_TYPE = "application/octet-stream"
+
+    PATH = "uploads"
+    attr_accessor :id, :content_length, :content_type
+
+    # Creates an upload with the specified items, all required.
+    # will return an a new upload object that has it's ID which can be
+    # used to upload. The following are known content types:
+    # image/vnd.climate.thermal.geotiff, image/vnd.climate.ndvi.geotiff, 
+    # image/vnd.climate.chlorophyll.geotiff, image/vnd.climate.cci.geotiff,
+    # image/vnd.climate.waterstress.geotiff, image/vnd.climate.infrared.geotiff
+    def self.create(auth_token, md5, content_length, content_type)
+      response = auth_token.execute_request!(:post, PATH,
+        params: {
+          "md5" => md5,
+          "length" => content_length,
+          "content-type" => content_type
+      })
+
+      Util.verify_response_with_code("Upload creation", response, 201)
+
+      return new(response.http_body.gsub('"', ''), content_length, auth_token)
+    end
+
+    def initialize(id, content_length, auth_token = nil)
+      self.id = id
+      self.content_length = content_length.to_i
+      if self.content_length <= 0 then
+        raise ArgumentError.new("You must set content_length to a non-zero value")
+      end
+      super(auth_token)
+    end
+
+    # Upload a chunk of a file, specify the range of the bytes, 0 based, for the bytes
+    # you're passing, for example, the first 256 bytes would be start_bytes = 0 and 
+    # end_bytes = 255, with bytes = 256 byte size object
+    def upload_chunk(start_bytes, end_bytes, bytes)
+      if (end_bytes.to_i - start_bytes.to_i + 1) != bytes.bytesize ||
+        bytes.bytesize > REQUIRED_CHUNK_SIZE then
+        raise ArgumentError.new("End bytes (#{end_bytes}) - Start bytes (#{start_bytes})" \
+          " must be equal to bytes (#{bytes}) and no greater than #{REQUIRED_CHUNK_SIZE}")
+      end
+      response = auth_token.execute_request!(:put, "#{PATH}/#{self.id}",
+        headers: {
+          "Content-Range" => "bytes #{start_bytes}-#{end_bytes}/#{self.content_length}",
+          "Content-Length" => bytes.bytesize,
+          "Content-Type" => CHUNK_CONTENT_TYPE,
+          "Transfer-Encoding" => "chunked"
+        },
+        params: bytes)
+
+      # We expect a 204
+      Util.verify_response_with_code("Chunk upload", response, 204)
+
+      return response
+    end
+  end
+end

data/lib/fieldview/util.rb

@@ -3,5 +3,12 @@ module FieldView
     def self.http_status_is_more_in_list?(http_status)
       return http_status.to_i == 206
     end
+
+    def self.verify_response_with_code(message, fieldview_response, *acceptable_response_codes)
+      if not acceptable_response_codes.include?(fieldview_response.http_status) then
+        raise UnexpectedResponseError.new("#{message} expects #{acceptable_response_codes}",
+          fieldview_response: fieldview_response)
+      end
+    end
   end
 end

data/lib/fieldview/version.rb

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

data/lib/fieldview.rb

@@ -3,13 +3,18 @@ require 'json'
 require 'rbconfig'
 require 'base64'
 
+# Version
+require 'fieldview/version'
+
 # API Support Classes
 require 'fieldview/errors'
+require 'fieldview/requestable'
 require 'fieldview/auth_token'
 require 'fieldview/fields'
 require 'fieldview/util'
 require 'fieldview/fieldview_response'
 require 'fieldview/field'
+require 'fieldview/upload'
 require 'fieldview/list_object'
 require 'fieldview/boundary'
 

data/test/test_auth_token.rb

@@ -9,8 +9,8 @@ class TestAuthToken < Minitest::Test
   def check_token_matches_fixture(token)
     assert_equal FIXTURE[:access_token], token.access_token
     assert_equal FIXTURE[:refresh_token], token.refresh_token
-    assert_equal FieldView.now + FIXTURE[:expires_in] - 15, token.access_token_expiration_at
-    assert_equal FieldView.now - 5 + 29*24*60*60, token.refresh_token_expiration_at, "Should be 29 days in the future"
+    assert_equal FieldView.now + FIXTURE[:expires_in] - 5, token.access_token_expiration_at
+    assert_equal FieldView.now + 30*24*60*60 - 5, token.refresh_token_expiration_at, "Should be 30 days in the future"
   end
 
   def setup

data/test/test_helper.rb

@@ -13,6 +13,9 @@ class Minitest::Test
   #
   API_FIXTURES = APIFixtures.new
 
+  def teardown
+    WebMock.reset!
+  end
 
   def next_token_headers(next_token = "AZXJKLA123")
     return {FieldView::NEXT_TOKEN_HEADER_KEY => next_token}

data/test/test_upload.rb

@@ -0,0 +1,89 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestUpload < Minitest::Test
+
+  def setup
+    setup_for_api_requests
+  end
+  
+  def teardown
+    teardown_for_api_request
+  end
+
+  def test_expects_certain_status_code
+    stub_request(:post, /uploads/).
+      to_return(status: 200)
+
+    assert_raises(FieldView::UnexpectedResponseError) do
+      FieldView::Upload.create(new_auth_token, "dontcare", 5, "dontcare")
+    end
+  end
+  
+  def test_create()
+    md5 = "eb782356d6011dab2b112bdcb098ec7d"
+    uuid = "1a2623b3-d2a7-4e52-ba21-a3eb521a3208"
+    content_length = 275
+    content_type = "image/vnd.climate.thermal.geotiff"
+    stub_request(:post, /uploads/).
+      with(body: {
+          "md5" => md5,
+          "length" => content_length,
+          "content-type" => content_type
+      }).
+      to_return(status: 201, body: %Q!"#{uuid}"!)
+
+    auth_token = new_auth_token
+
+    upload = FieldView::Upload.create(auth_token, md5, content_length, content_type)
+
+    assert_equal uuid, upload.id
+    assert_equal content_length, upload.content_length
+    assert_equal auth_token, upload.auth_token
+  end
+
+  def test_checks_content_length
+    assert_raises(ArgumentError) do
+      # nil is going to result in 0 when converting to integer
+      FieldView::Upload.new(1,nil,new_auth_token)
+    end
+  end
+
+  def test_uploading_wrong_chunk_size
+    upload = FieldView::Upload.new("dontcare", 
+      50000000, new_auth_token)
+
+    bytes = "12345678"
+    start_bytes = 0
+    end_bytes = 5
+    assert_raises(ArgumentError, "Wrong byte start/end") do
+      upload.upload_chunk(start_bytes, end_bytes, bytes)
+    end
+
+    bytes = "A" * (FieldView::Upload::REQUIRED_CHUNK_SIZE + 1)
+    end_bytes = bytes.bytesize - 1
+    assert_raises(ArgumentError, "Larger than the accepted chunk size") do
+      upload.upload_chunk(start_bytes, end_bytes, bytes)
+    end
+  end
+
+  def test_can_upload_chunk
+    uuid = "1a2623b3-d2a7-4e52-ba21-a3eb521a3208"
+    total_content_length = FieldView::Upload::REQUIRED_CHUNK_SIZE * 2
+    upload = FieldView::Upload.new(uuid, 
+      total_content_length, new_auth_token)
+
+    chunk = "A"
+    start_bytes = 0
+    end_bytes = chunk.bytesize - 1
+
+    stub_request(:put, /uploads\/#{uuid}/).
+      with(headers: {
+        content_range: "bytes #{start_bytes}-#{end_bytes}/#{total_content_length}",
+        content_length: chunk.bytesize.to_s,
+        content_type: "application/octet-stream",
+        transfer_encoding: "chunked"
+      }).
+      to_return(status: 204, body: nil)
+    assert upload.upload_chunk(start_bytes, end_bytes, chunk)
+  end
+end

metadata

@@ -1,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fieldview
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Paul Susmarski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
-description: ' FieldView is used make data-driven decisions to maximize your return
-  on every acre.'
+date: 2017-04-19 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.'
 email: paul@susmarski.com
 executables: []
 extensions: []
@@ -46,7 +32,10 @@ files:
 - lib/fieldview/fields.rb
 - lib/fieldview/fieldview_response.rb
 - lib/fieldview/list_object.rb
+- lib/fieldview/requestable.rb
+- lib/fieldview/upload.rb
 - lib/fieldview/util.rb
+- lib/fieldview/version.rb
 - spec/fixtures.json
 - test/api_fixtures.rb
 - test/test_auth_token.rb
@@ -56,6 +45,7 @@ files:
 - test/test_fieldview.rb
 - test/test_helper.rb
 - test/test_list_object.rb
+- test/test_upload.rb
 homepage: http://rubygems.org/gems/fielview
 licenses:
 - MIT
@@ -89,3 +79,4 @@ test_files:
 - test/test_fieldview.rb
 - test/test_helper.rb
 - test/test_list_object.rb
+- test/test_upload.rb