fieldview 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c291877633d7f4126668164ee7cc60c7c5c67bac
+  data.tar.gz: df16497405345a46fab2c65066eec659ffc074b7
+SHA512:
+  metadata.gz: 883b9f63fcaf3af60958bc8407660a76608afca697fa043afae906240d6c7f2f36ed3116dea2de6c76630c3e4ba82effe08d6d11ab3e349c4cb03b962eae052d
+  data.tar.gz: 8d027e67cdabf34fd66a7284196c34533d82b2f002df8826b2d91b8005ae4246fb8632225f5b67041dd518c465a4826244f5e5eabc9e7a2d6927acb91d63808d

data/.gitignore

@@ -0,0 +1,52 @@
+*agribotix*
+*.gem
+*.rbc
+*.byebug*
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'minitest'
+  gem 'webmock'
+  gem 'rake'
+  platforms :mri do
+    # to avoid problems, bring Byebug in on just versions of Ruby under which
+    # it's known to work well
+    if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.0.0')
+      gem 'byebug'
+    end
+  end
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    fieldview (0.0.0)
+      faraday (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    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)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  fieldview!
+  minitest
+  rake
+  webmock
+
+BUNDLED WITH
+   1.13.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Paul Susmarski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# FieldView API Library
+
+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.
+
+## Usage
+
+The library needs to be configured with your FieldView account's client secret,
+client id, and x-api-key which would be provided to you by a Climate 
+representative. Set these according to the their values
+
+``` ruby
+require "fieldview"
+
+FieldView.client_id = "fake-client"
+FieldView.client_secret = "fake-client-..."
+FieldView.x_api_key = "..."
+
+# Required if acquiring a new auth token without refresh tokens
+FieldView.redirect_uri = "http://my.local.host/path/that/users/are/directed" 
+
+
+# Get an Auth token
+auth_token = FieldView::AuthToken.new_auth_token_with_code_from_redirect_code(<CODE>)
+
+# Or initialize with previous information
+auth_token = FieldView::AuthToken.new(
+    access_token: <ATOKEN>, 
+    expiration_at: <DATETIME>,
+    refresh_token: <RTOKEN>,
+    refresh_token_expiration_at: <DATETIME>)
+
+# Or with just auth_token (assuming it hasn't expired)
+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>) 
+
+
+```
+
+## Development
+
+Run all tests:
+
+    bundle exec rake
+
+Run a single test suite:
+
+    bundle exec ruby -Ilib/ test/field_view_test.rb
+
+Run a single test:
+
+    bundle exec ruby -Ilib/ test/field_view_test.rb -n /client.id/
+
+## 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/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/test_*.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/fieldview.gemspec

@@ -0,0 +1,21 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+spec = Gem::Specification.new do |s|
+  s.name = 'fieldview'
+  s.version = "0.0.0"
+  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.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")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/fieldview/auth_token.rb

@@ -0,0 +1,111 @@
+module FieldView
+  class AuthToken
+    attr_accessor :access_token, :access_token_expiration_at, :refresh_token, :refresh_token_expiration_at
+    attr_accessor :last_request
+    def initialize(params)
+      # Assume now was 5 seconds ago
+      now = FieldView.get_now_for_auth_token - 5
+
+      # Used on every request
+      self.access_token = params[:access_token]
+
+      # 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)
+
+      # 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)
+    end
+
+    def access_token_expired?
+      return !!(self.access_token.nil? || self.access_token_expiration_at <= Time.now)
+    end
+
+    def refresh_token_expired?
+      return !!(self.refresh_token.nil? || self.refresh_token_expiration_at <= Time.now)
+    end
+
+    def refresh_access_token!()
+      http, request = self.class.build_token_request([
+        ["grant_type", "refresh_token"],
+        ["refresh_token", self.refresh_token]
+      ])
+      response = http.request(request)
+      if response.code != "200" then
+        # An error has occurred, log to roll bar and notify them
+        raise RefreshTokenError.new("Failed to refresh FieldView token, response body: #{response.body}")
+      else
+        json = JSON.parse(response.body, symbolize_names: true)
+        initialize(json)
+      end
+    end
+
+    def execute_request!(method, path, headers: {}, params: {})
+      self.last_request = path
+      if access_token_expired? && refresh_token_expired? then
+        raise AllTokensExpiredError.new("All of your tokens have expired. " \
+          "You'll need to re-log into FieldView.")
+      end
+
+      if access_token_expired? then
+        refresh_access_token!()
+      end
+      uri = URI.parse("#{FieldView.api_base}#{FieldView.api_version}/#{path}")
+
+      # TODO: Handle parameters
+      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)
+      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)
+    end
+
+    def self.build_token_request(url_params)
+      uri = URI.parse(FieldView.oauth_token_base)
+      new_query_ar = URI.decode_www_form(uri.query || '') 
+      url_params.each do |param| 
+        new_query_ar << param
+      end
+      uri.query = URI.encode_www_form(new_query_ar)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request["Accept"] = "*/*"
+      request["Authorization"] = "Basic #{Base64.encode64("#{FieldView.client_id}:#{FieldView.client_secret}").strip}"
+      request["Content-Type"] = "application/x-www-form-urlencoded"
+      return http, request
+    end
+
+    # Code will be collected from the redirect to your server
+    def self.new_auth_token_with_code_from_redirect_code(code)
+      http, request = build_token_request([
+        ["grant_type", "authorization_code"],
+        ["redirect_uri", FieldView.redirect_uri],
+        ["code", code]
+      ])
+      response = http.request(request)
+      if response.code != "200" then
+        raise AuthenticationError.new("Was unable to get a new auth token using the code provided. " \
+          "See response body: #{response.body}")
+      else
+        json = JSON.parse(response.body, symbolize_names: true)
+        return AuthToken.new(json)
+      end
+    end
+  end
+end

data/lib/fieldview/boundary.rb

@@ -0,0 +1,28 @@
+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)
+      self.id = json_object[:id]
+      self.area = json_object[:area][:q]
+      self.units = json_object[:area][:u]
+      self.centroid = Feature.new(json_object[:centroid])
+      self.geometry = Feature.new(json_object[:geometry])
+    end
+  end
+end

data/lib/fieldview/errors.rb

@@ -0,0 +1,64 @@
+module FieldView
+  # FieldViewError is the base error from which all other more specific FieldView
+  # errors derive.
+  class FieldViewError < StandardError
+    attr_reader :message
+
+    # These fields are now available as part of #response and that usage should
+    # be preferred.
+    attr_reader :http_body
+    attr_reader :http_headers
+    attr_reader :http_status
+    attr_reader :request_id
+
+    attr_accessor :response
+    # Initializes a FieldViewError.
+    def initialize(message=nil, http_status: nil, http_body: nil,
+                   http_headers: nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @http_headers = http_headers || {}
+      @request_id = @http_headers[FieldView::REQUEST_ID_HEADER_KEY]
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      id_string = @request_id.nil? ? "" : "(Request #{@request_id}) "
+      "#{status_string}#{id_string}#{@message}"
+    end
+  end
+
+  # AuthenticationError is raised when invalid credentials are used to connect
+  # to FieldView's servers.
+  class AuthenticationError < FieldViewError
+  end
+
+  # Raised when all the tokens expired and nothing can be done.
+  class AllTokensExpiredError < FieldViewError
+  end
+
+  # Raised when access resources you don't have access to
+  class PermissionError < FieldViewError
+  end
+
+  # Raised when a refresh token is attempted to be used but it can't be
+  class RefreshTokenError < FieldViewError
+  end
+
+  # Raised when too many requests are being made
+  class RateLimitError < FieldViewError
+  end
+
+  # Raised when accessing a non-existent resource
+  class InvalidRequestError < FieldViewError
+  end
+
+  # Raised when something goes wrong with FieldView
+  class InternalServerError < FieldViewError
+  end
+
+  # Raised when the server is busy
+  class ServerBusyError < FieldViewError
+  end
+end

data/lib/fieldview/field.rb

@@ -0,0 +1,22 @@
+module FieldView
+  class Field
+    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
+    end
+
+    def boundary
+      @boundary ||= nil
+      if @boundary.nil?
+        @boundary = Boundary.new(self.auth_token.execute_request!(:get, "boundaries/#{self.boundary_id}").data)
+      end
+      return @boundary
+    end
+  end
+end

data/lib/fieldview/fields.rb

@@ -0,0 +1,34 @@
+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/lib/fieldview/fieldview_response.rb

@@ -0,0 +1,24 @@
+module FieldView
+  class FieldViewResponse
+    attr_accessor :request_id
+    attr_accessor :http_body
+    attr_accessor :http_headers
+    attr_accessor :http_status
+    attr_accessor :data
+    def initialize(response)
+      self.http_headers = {}
+      response.each_capitalized_name do |n|
+        self.http_headers[n] = response[n]
+      end
+      
+      self.http_body = response.body
+      begin
+        self.data = JSON.parse(response.body, symbolize_names: true)
+      rescue JSON::ParserError
+        self.data = nil
+      end
+      self.http_status = response.code.to_i
+      self.request_id = self.http_headers[FieldView::REQUEST_ID_HEADER_KEY]
+    end
+  end
+end

data/lib/fieldview/list_object.rb

@@ -0,0 +1,43 @@
+module FieldView
+  class ListObject
+    attr_accessor :limit
+    attr_reader :auth_token, :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
+    end
+
+    def each(&blk)
+      self.data.each(&blk)
+    end
+
+    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
+    end
+
+    # alias for more_pages
+    def has_more?()
+      return self.more_pages?()
+    end
+
+    def more_pages?()
+      return Util.http_status_is_more_in_list?(self.last_http_status)
+    end
+
+    def restart!()
+      @last_http_status = nil
+      @next_token = nil
+      next_page!()
+    end
+  end
+end

data/lib/fieldview/util.rb

@@ -0,0 +1,7 @@
+module FieldView
+  class Util
+    def self.http_status_is_more_in_list?(http_status)
+      return http_status.to_i == 206
+    end
+  end
+end

data/lib/fieldview.rb

@@ -0,0 +1,130 @@
+require 'net/http'
+require 'json'
+require 'rbconfig'
+require 'base64'
+
+# API Support Classes
+require 'fieldview/errors'
+require 'fieldview/auth_token'
+require 'fieldview/fields'
+require 'fieldview/util'
+require 'fieldview/fieldview_response'
+require 'fieldview/field'
+require 'fieldview/list_object'
+require 'fieldview/boundary'
+
+module FieldView
+  @oauth_token_base = "https://api.climate.com/api/oauth/token"
+  @api_base = "https://platform.climate.com/v"
+  @max_network_retries = 0
+  @api_version = 4
+  @default_page_limit = 100
+  NEXT_TOKEN_HEADER_KEY = "X-Next-Token"
+  REQUEST_ID_HEADER_KEY = "X-Http-Request-Id"
+  PAGE_LIMIT_HEADER_KEY = "X-Limit"
+
+  class << self
+    attr_accessor :oauth_token_base, :api_base, :max_network_retries, :api_version, :now,
+      :default_page_limit
+
+    def get_now_for_auth_token
+      now || Time.now
+    end
+
+    def x_api_key
+      @_x_api_key ||= nil
+      unless @_x_api_key
+        raise AuthenticationError.new('No x-api-key provided. ' \
+          'Set your x-api-key using "FieldView.x_api_key = <X-API-KEY>". ' \
+          'This should have been provided to you by a Climate representative. ' \
+          'This takes the form of "my-client"')
+      end
+      return @_x_api_key
+    end
+    def x_api_key=(value)
+      @_x_api_key = value
+    end
+
+    def redirect_uri
+      @_redirect_uri ||= nil
+      unless @_redirect_uri
+        raise AuthenticationError.new("You must set the redirect uri to your proper server " \
+          "to get new auth tokens if you haven't set one. " \
+          "Set your redirect uri using FieldView.redirect_uri = <REDIRECT_URI>")
+      end
+      return @_redirect_uri
+    end
+    def redirect_uri=(value)
+      @_redirect_uri = value
+    end
+
+    def client_id
+      @_client_id ||= nil
+      unless @_client_id
+        raise AuthenticationError.new('No client id provided. ' \
+          'Set your client id using "FieldView.client_id = <CLIENT-ID>". ' \
+          'This should have been provided to you by a Climate representative. ' \
+          'This takes the form of "my-client"')
+      end
+      return @_client_id
+    end
+    def client_id=(value)
+      @_client_id = value
+    end
+
+    def client_secret
+      @_client_secret ||= nil
+      unless @_client_secret
+        raise AuthenticationError.new('No client_secret provided. ' \
+          'Set your client secret using "FieldView.client_secret = <CLIENT-SECRET>". ' \
+          'This should have been provided to you by a Climate representative. ' \
+          'This takes the form of "my-client-fz9900x98-x98908j-jslx"')
+      end
+      return @_client_secret
+    end
+    def client_secret=(value)
+      @_client_secret = value
+    end
+
+    def handle_response_error_codes(response)
+      headers = response.to_hash
+      code = response.code.to_i
+      body = response.body
+      error = nil
+      case code
+      when 503
+        error = ServerBusyError.new(
+          "Server Busy", http_status: code, http_body: body,
+          http_headers: headers)
+      when 400, 404
+        error = InvalidRequestError.new(
+          "Bad input", http_status: code, http_body: body,
+          http_headers: headers)
+      when 401
+        error = AuthenticationError.new(
+          "Unauthorized", http_status: code, http_body: body,
+          http_headers: headers)
+      when 403
+        error = PermissionError.new(
+          "Forbidden", http_status: code, http_body: body,
+          http_headers: headers)
+      when 429
+        # Retry-After will be in the headers
+        error = RateLimitError.new(
+          "Too many requests", http_status: code, http_body: body,
+          http_headers: headers)
+      when 500
+        error = InternalServerError.new(
+          "Internal server error", http_status: code, http_body: body,
+          http_headers: headers)
+      end
+        
+      if error.nil? then
+        return
+      else
+        error.response = response
+        raise error
+      end
+    end
+  end
+end

data/spec/fixtures.json

@@ -0,0 +1,141 @@
+{
+  "boundary_one": {
+    "id": "e694b43e-86eb-4773-86d0-3c4f546178dc",
+    "area": {
+      "q": 58.923473472390256,
+      "u": "ac"
+    },
+    "centroid": {
+      "type": "Point",
+      "coordinates": [
+        -105.223479062131,
+        40.0579906147381
+      ]
+    },
+    "geometry": {
+      "type": "MultiPolygon",
+      "coordinates": [
+        [
+          [
+            [
+              -105.2255165,
+              40.0437726
+            ],
+            [
+              -105.2208496,
+              40.0438021
+            ],
+            [
+              -105.2208915,
+              40.0402151
+            ],
+            [
+              -105.2255049,
+              40.0402473
+            ],
+            [
+              -105.2255165,
+              40.0437726
+            ]
+          ]
+        ],
+        [
+          [
+            [
+              -105.2257098,
+              40.087157
+            ],
+            [
+              -105.2257173,
+              40.0903676
+            ],
+            [
+              -105.2249648,
+              40.0898429
+            ],
+            [
+              -105.2232786,
+              40.0894078
+            ],
+            [
+              -105.2226989,
+              40.0886577
+            ],
+            [
+              -105.2218189,
+              40.0883161
+            ],
+            [
+              -105.2218299,
+              40.0879038
+            ],
+            [
+              -105.2217414,
+              40.0874009
+            ],
+            [
+              -105.2214516,
+              40.0871603
+            ],
+            [
+              -105.2257098,
+              40.087157
+            ]
+          ]
+        ]
+      ]
+    }
+  },
+  "single_field_list": {
+    "results": [
+      {
+        "id": "530dd6e4-170b-4254-b10c-ef07b9533f74",
+        "name": "NE of Airport",
+        "boundaryId": "e694b43e-86eb-4773-86d0-3c4f546178dc"
+      }
+    ]
+  },
+  "field_two_list": {
+    "results": [
+      {
+        "id": "687c5ad6-7969-4112-8234-f8b5474a7389",
+        "name": "SE of Airport",
+        "boundaryId": "0a34b7bc-3f6b-4ace-9e6d-f97a7c6b66b9"
+      }
+    ]
+  },
+  "authorization": {
+    "access_token": "b2a58121-e02e-4c56-9036-ac23eb295ddc",
+    "token_type": "bearer",
+    "refresh_token": "23bba1b4-4e61-4e41-83fb-620061158239",
+    "expires_in": 14399,
+    "scope": "openid partnerapis platform",
+    "id_token": "8s9nxjx908uoij12oik2j4.1j4kjs90ivcoixkjmxrw3um493u8924u4yuemnshfjdsen450q.dG9rZW4iLCJhdWQiOiJwYXJ0bmVyLWFncmlib3RpeCIsImV4cCI6MTQ5MTk0NTUzNSwiaWF0IjoxNDkxOTQ0OTM1LCJhdXRoX3RpbWUiOjE0OTE5NDQ5MzUsInVzZXJfaWQiOiIxODYzNzUiLCJzdWIiOiIxODYzNzUiLCJlbWFpbCI6ImNvbXB1dGVAYWdyaWJvdGl4LmNvbSIsImFkZHJlc3MiOnt9LCJyb2xlcyI6WyJjbGllbnQiXSwicGhvbmVfbnVtYmVyIjoiMzAzNzE3ODk3OSJ9.TjSPzpdIUUQMD3wh_-PCdB2o0M8n1tpWAeicQ-Wz-AwXsbmxesDnZroppsN-0_H_8ULOhSKwlGVGEuuD6QfYElhlGZuviSZcYkwYDNtXNN9oVa4MgfWK76txLV59oaGpFuHlqKGMskL4uV5Ao_H9_0jN1THqluav-WUh4WwxB-LclIu4i7gv1g5Bw5zpzzccQAzErc04u_Gf1gwi1IZtFYJJncSnnm1hp5XhBZgLZD0twiNOYzxML3nFbM37WEf1G3iqSLiTH1bIKc_MO7dG3o8oq3SoYjDmjRWl7iL7WD3jZHWiAuvVBa0rDqOOeVpCPUYPk62n9HJ6JNtMnSp3eUvnR8nfaOvm7P1ZehOAVnJVq1yWfjOtxEvjLBmD7wRs9I5N2OANiLgqvnvJVy_BuAqQXDqmgusrU9FotGRP2obSRfZvaPzxXurCYY9OfS8uxxHBlzVe06dTNRezuOzy_op7y33dOEOzFfoBNyFcTtlptcICs6uIsGC_k239auWTiMKIGgAdtbgoAvVLK49-s7IdX9gfUv9ugaZgduPDq6hzxWQh-Uahyf1LkpLfb9wTHPdq9upW8Dt5iSBQKcngCBdLjR3WrGIRi0M0m2beRSB-acUiIWreeoCOY78UErEd5ebYwfBaAFh1Igy5EfvfYyaNjhv1-cYX8q3fc2JBPPU",
+    "user": {
+      "tosacceptedat": null,
+      "email": "testing@test.com",
+      "firstviews": 0,
+      "phone": "5555555555",
+      "roles": [
+        "Client"
+      ],
+      "city": null,
+      "firstname": "Testing",
+      "source": "user-service-default",
+      "address1": null,
+      "mailchimp": false,
+      "address2": null,
+      "zip": null,
+      "id": 186375,
+      "state": null,
+      "lastname": "Lastname",
+      "uuid": "ca9cdad5-c759-44b5-9442-371338f301a9",
+      "enabled": true,
+      "country": "United States",
+      "asOf": 1491944935932
+    },
+    "site": {
+      "siteCode": "fccd95c45c048f7c8c9a60c8"
+    }
+  }
+}

data/test/api_fixtures.rb

@@ -0,0 +1,26 @@
+class APIFixtures
+  def initialize
+    @fixtures = ::JSON.parse(File.read("#{PROJECT_ROOT}/spec/fixtures.json"),
+      symbolize_names: true)
+    freeze_recursively(@fixtures)
+  end
+
+  def [](name)
+    @fixtures[name]
+  end
+
+  def fetch(*args)
+    @fixtures.fetch(*args)
+  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_auth_token.rb

@@ -0,0 +1,91 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestAuthToken < Minitest::Test
+  FIXTURE = API_FIXTURES.fetch(:authorization)
+  def auth_uri_stub
+    "#{prefix_for_all_requests}#{FieldView.oauth_token_base[8..-1]}"
+  end
+
+  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"
+  end
+
+  def setup
+    setup_for_api_requests
+  end
+  
+  def teardown
+    teardown_for_api_request
+  end
+
+  def test_build_token_request
+    http, request = FieldView::AuthToken.build_token_request([["dont", "care"]])
+    assert_equal "/api/oauth/token?dont=care", request.path
+
+    headers = request.to_hash
+    assert_equal ["*/*"], headers["accept"]
+    assert_equal ["Basic #{Base64.encode64("#{FieldView.client_id}:#{FieldView.client_secret}").strip}"], headers["authorization"]
+    assert_equal ["application/x-www-form-urlencoded"], headers["content-type"]
+
+    assert_equal Net::HTTP::Post, request.class
+    assert_equal "api.climate.com", http.address
+  end
+
+  def test_new_auth_token_with_code_from_redirect_code_bad
+    stub_request(:post, "#{auth_uri_stub}?" \
+      "code&grant_type=authorization_code&redirect_uri=#{FieldView.redirect_uri}").
+        to_return(status: 401, body: JSON.generate({}))
+    assert_raises FieldView::AuthenticationError do
+      FieldView::AuthToken.new_auth_token_with_code_from_redirect_code(nil)
+    end
+  end
+
+  def test_new_auth_token_with_code_from_redirect_code_good
+    # now a good token
+    code = "code"
+    FieldView.now = Time.now
+    stub_request(:post, "#{auth_uri_stub}?" \
+      "code=#{code}&grant_type=authorization_code&redirect_uri=#{FieldView.redirect_uri}").
+        to_return(status: 200, body: JSON.generate(FIXTURE))
+    token = FieldView::AuthToken.new_auth_token_with_code_from_redirect_code(code)
+    check_token_matches_fixture(token)
+  end
+
+  def test_create_with_just_access_token
+    token = FieldView::AuthToken.new(access_token: "yyy")
+    assert !token.access_token_expired?
+    assert token.refresh_token_expired?
+  end
+
+  def test_create_with_just_refresh_token
+    FieldView.now = Time.now
+    token = FieldView::AuthToken.new(refresh_token: "xxx")
+    assert token.access_token_expired?
+    assert !token.refresh_token_expired?
+
+    stub_request(:post, "#{auth_uri_stub}?" \
+      "grant_type=refresh_token&refresh_token=#{token.refresh_token}").
+      to_return(status: 200, body: JSON.generate(FIXTURE))
+    token.refresh_access_token!
+    check_token_matches_fixture(token)
+  end
+
+  def test_completely_expired_token
+    token = FieldView::AuthToken.new(
+      access_token: "yyy",
+      refresh_token: "xxx",
+      refresh_token_expiration_at: Time.now - 20,
+      access_token_expiration_at: Time.now - 20
+      )
+
+    assert token.access_token_expired?
+    assert token.refresh_token_expired?
+
+    assert_raises FieldView::AllTokensExpiredError do
+      token.execute_request!(:get, "dont/care")
+    end
+  end
+end

data/test/test_boundary.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestBoundary < Minitest::Test
+  FIXTURE = API_FIXTURES.fetch(:boundary_one)
+  def test_initialization
+    boundary = FieldView::Boundary.new(FIXTURE)
+  
+    assert_equal FIXTURE[:id], boundary.id
+    assert_equal 58.923473472390256, boundary.area
+    assert_equal "ac", boundary.units
+    assert_equal 2, boundary.centroid.coordinates.length
+    assert boundary.centroid.point?
+    assert_equal 2, boundary.geometry.coordinates.length
+    assert boundary.geometry.multi_polygon?
+    assert boundary.geometry.multi_polygon? != boundary.centroid.multi_polygon?, "make sure they are different types"
+  end
+end

data/test/test_field.rb

@@ -0,0 +1,26 @@
+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)
+  
+    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_get_boundary
+    field = FieldView::Field.new(FIXTURE, new_auth_token)
+
+    stub_request(:get, /boundaries\/#{API_FIXTURES[:boundary_one][:id]}/).
+      to_return(status: 200, body: API_FIXTURES[:boundary_one].to_json())
+
+    api_requests() do
+      field.boundary
+    end
+
+    assert_equal FIXTURE[:boundaryId], field.boundary.id
+  end
+end

data/test/test_fields.rb

@@ -0,0 +1,70 @@
+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

data/test/test_fieldview.rb

@@ -0,0 +1,46 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestFieldView < Minitest::Test
+  def test_now
+    assert (Time.now - FieldView.get_now_for_auth_token) <= 5, "should be close"
+    expected_time = Time.now - 20
+    FieldView.now = expected_time
+    assert_equal expected_time, FieldView.get_now_for_auth_token
+  end
+
+  def test_requires_client_id
+    FieldView.client_id = nil
+    assert_raises FieldView::AuthenticationError do
+      FieldView.client_id
+    end
+    FieldView.client_id = "test"
+    assert FieldView.client_id
+  end
+
+  def test_requires_client_secret
+    FieldView.client_secret = nil
+    assert_raises FieldView::AuthenticationError do
+      FieldView.client_secret
+    end
+    FieldView.client_secret = "test"
+    assert FieldView.client_secret
+  end
+
+  def test_requires_redirect_uri
+    FieldView.redirect_uri = nil
+    assert_raises FieldView::AuthenticationError do
+      FieldView.redirect_uri
+    end
+    FieldView.redirect_uri = "test"
+    assert FieldView.redirect_uri
+  end
+
+  def test_requires_x_api_key
+    FieldView.x_api_key = nil
+    assert_raises FieldView::AuthenticationError do
+      FieldView.x_api_key
+    end
+    FieldView.x_api_key = "test"
+    assert FieldView.x_api_key
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,52 @@
+require 'minitest/autorun'
+require 'fieldview'
+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 next_token_headers(next_token = "AZXJKLA123")
+    return {FieldView::NEXT_TOKEN_HEADER_KEY => next_token}
+  end
+
+  def new_auth_token
+    FieldView::AuthToken.new(
+      access_token: "yyy",
+      refresh_token: "xxx"
+      )
+  end
+
+  def api_requests()
+    setup_for_api_requests
+    yield
+    teardown_for_api_request
+  end
+
+  def setup_for_api_requests()
+    FieldView.redirect_uri = "http://fake.test/"  
+    FieldView.client_id = "fake-client"
+    FieldView.client_secret = "fake-client-abcdef12-3456-7890-abcd-ef0123456789"
+    FieldView.x_api_key = "ixj98c98njkn109su9jxkjks61"
+  end
+
+  def teardown_for_api_request()
+    FieldView.redirect_uri = nil
+    FieldView.client_id = nil
+    FieldView.client_secret = nil
+    FieldView.x_api_key = nil
+    FieldView.now = nil
+  end
+
+  def prefix_for_all_requests
+    "https://"
+  end
+end

data/test/test_list_object.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestListObject < Minitest::Test
+  FIXTURE = API_FIXTURES.fetch(:single_field_list)
+
+  def test_each_loop
+    data = ["x","y","z"]
+    list = FieldView::ListObject.new(FieldView::Fields, new_auth_token, data, 200, next_token: nil)
+
+    list.each_with_index do |x, i|
+      assert_equal data[i], x
+    end
+  end
+
+  def test_get_next_page
+    next_token = "JZIOJKLJ"
+    list = FieldView::ListObject.new(FieldView::Fields, new_auth_token, 
+      ["dont","care"], 206, next_token: next_token)
+    stub_request(:get, /fields/).
+      with(headers: next_token_headers(next_token)).
+      to_return(status: 200, body: API_FIXTURES[:field_two_list].to_json(),
+        headers: next_token_headers())
+
+    api_requests() do
+      list.next_page!()
+    end
+
+    assert_equal 1, list.data.length
+    assert_equal  API_FIXTURES[:field_two_list][:results][0][:id], list.data[0].id
+    assert !list.more_pages?()
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: fieldview
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+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.'
+email: paul@susmarski.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fieldview.gemspec
+- lib/fieldview.rb
+- lib/fieldview/auth_token.rb
+- lib/fieldview/boundary.rb
+- lib/fieldview/errors.rb
+- lib/fieldview/field.rb
+- lib/fieldview/fields.rb
+- lib/fieldview/fieldview_response.rb
+- lib/fieldview/list_object.rb
+- lib/fieldview/util.rb
+- spec/fixtures.json
+- test/api_fixtures.rb
+- 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
+homepage: http://rubygems.org/gems/fielview
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the FieldView API
+test_files:
+- test/api_fixtures.rb
+- 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