agx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12a614baa601cb06ea43c79debbe22c3796dfe86
+  data.tar.gz: 8e9c959807c63150179794206fa24fc81cbb276b
+SHA512:
+  metadata.gz: ee30307fc2cb28199560bfa331f984ec3513142fe048422f3941b653a4f470464e0e185c4a4e5cd48717ce0603c5f334f780b9d46c1b48cf58788ffa5fc97aae
+  data.tar.gz: 24e24fbfa71a88b00b264a4b99d0a26161d481ccfce929ea247da8a5e6476870eb5fc8f8aade2e9670347432944cdc03276c68d606b1b46e1aede10b0ce436a7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Required for allowing Client Credentials w/ Bearer auth instead of Basic
+# See: https://github.com/intridea/oauth2/pull/252
+gem 'oauth2', github: 'CropQuest/oauth2', branch: 'client_credentials_header'
+
+# Specify your gem's dependencies in agx.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Crop Quest, Inc.
+
+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,117 @@
+# agX Platform API Client
+
+[![Gem Version](http://img.shields.io/gem/v/agx.svg)][gem]
+
+[gem]: https://rubygems.org/gems/agx
+
+Ruby client for accessing SST Software's [agX Platform APIs](http://www.agxplatform.com/agx-apis/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'agx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install agx
+
+## Usage
+
+### agX Content API
+
+Setup agX Content Client (OAuth 2 Client Credentials Flow)
+```ruby
+@agx_content_client = Agx::Content::Client.new(
+  client_id: "your_client_id",
+  client_secret: "your_client_secret",
+  site: "content-api-endpoint-url", # optional
+  token_url: "auth-token-endpoint-url", # optional
+  version: "v1"  # optional
+)
+```
+
+Make get requests for Content API resources
+```ruby
+# @agx_content_client.get("ResourceName", params_hash)
+# => 'parsed_json_response_body'
+
+crops = @agx_content_client.get("Crop")
+
+# Passing in publishDate as param
+weeds = @agx_content_client.get("Weed", {publishDate: date.to_s})
+```
+
+### agX Sync API
+
+Setup agX Sync Client (OAuth 2 Authorization Code Flow)
+
+***This requires that you have already previously authenticated and authorized
+a user to agX through the authorization code grant flow process and have
+persisted their sync ID, access token, refresh token, and access token
+expiration timestamp.***
+
+```ruby
+@agx_sync_client = Agx::Sync::Client.new(
+  client_id: "your_client_id",
+  client_secret: "your_client_secret",
+  site: "sync-api-endpoint-url", # optional
+  host: "sync-api-endpoint-without-protocol", # optional
+  authorize_url: "authorize-endpoint-url", # optional
+  token_url: "auth-token-endpoint-url", # optional
+  version: "v3",  # optional
+  sync_id: "agx_user_sync_id",
+  access_token: "agx_user_agx_token",
+  refresh_token: "agx_user_refresh_token",
+  token_expires_at: "access_token_expiration_timestamp",
+  transaction_id: "agx_user_previous_transaction_id" # optional
+)
+```
+
+Initiate a sync transaction, make Sync API requests, and end transaction
+
+***Currently only get requests are supported***
+```ruby
+# @agx_sync_client.get("Resource", start_time)
+# => 'parsed_json_response_body'
+
+# You should persist transaction ID per user until transaction is successfully
+# ended by call to end_transaction
+transaction_id = @agx_sync_client.start_transaction
+
+growers = @agx_sync_client.get("Grower")
+
+# Get all farms accessible for a grower
+farms = @agx_sync_client.get("Grower/#{grower.guid}/Farm")
+
+# Get all server changes on farms accessible for a grower since start_time
+farms = @agx_sync_client.get("Grower/#{grower.guid}/Farm", last_sync_date.to_s)
+
+# etc...
+
+@agx_sync_client.end_transaction
+
+# clear the persisted transaction ID for user after ending sync transaction
+user_transaction_id = nil
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CropQuest/agx-ruby.
+
+
+## Copyright
+
+Copyright (c) 2016 [Crop Quest, Inc.](http://www.cropquest.com) See LICENSE.txt for details.
+
+[agX](http://www.agxplatform.com/) is a registered trademark of [SST Software](http://www.sstsoftware.com/).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/agx.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "agx"
+  spec.version       = Agx::VERSION
+  spec.authors       = ["Bryce Johnston"]
+  spec.email         = ["bjohnston@cropquest.com"]
+
+  spec.summary       = %q{Ruby client for accessing agX Platform APIs.}
+  spec.description   = %q{Ruby client for accessing SST Software's agX Platform APIs.}
+  spec.homepage      = "https://github.com/CropQuest/agx-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oj", "~> 2.17.1"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "agx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/agx/content/client.rb

@@ -0,0 +1,126 @@
+module Agx
+  module Content
+    class Client
+      attr_accessor :client_id, :client_secret, :site, :token_url, :version
+
+      def initialize(client_id: nil, client_secret: nil, site: nil, token_url: nil, version: nil)
+        @client_id = client_id || ENV['AGX_CONTENT_CLIENT_ID']
+        @client_secret = client_secret || ENV['AGX_CONTENT_CLIENT_SECRET']
+        @site = site || "https://refdata.agxplatform.com"
+        @token_url = token_url || "https://auth.agxplatform.com/Account/Token"
+        @version = version || "v1"
+        @client = set_client
+        @token = {
+          access_token: nil,
+          expires_at: nil
+        }
+      end
+
+      def get(resource, params = {})
+        validate_credentials
+
+        resource = "/api/#{@version}/#{resource}"
+        begin
+          response = current_token.get(resource, {:headers => { "oauth-scopes" => "referencedata" }, :params => params})
+          parse_response(response.body)
+        rescue => e
+          handle_error(e)
+        end
+      end
+
+      protected
+
+      def validate_credentials
+        unless @client_id && @client_secret
+          error = Agx::Error.new("agX Client Credentials Not Set", {title: "AGX_CREDENTIALS_ERROR"})
+          raise error
+        end
+      end
+
+      def parse_response(response_body)
+        parsed_response = nil
+
+        if response_body && !response_body.empty?
+          begin
+            parsed_response = Oj.load(response_body)
+          rescue Oj::ParseError
+            error = Agx::Error.new("Unparseable response: #{response_body}")
+            error.title = "UNPARSEABLE_RESPONSE"
+            error.status_code = 500
+            raise error
+          end
+        end
+
+        parsed_response
+      end
+
+      def handle_error(error)
+        error_params = {}
+
+        begin
+          if error.is_a?(OAuth2::Error) && error.response
+            error_params[:title] = "HTTP_#{error.response.status}_ERROR"
+            error_params[:status_code] = error.response.status
+            error_params[:raw_body] = error.response.body
+            error_params[:body] = Oj.load(error.response.body)
+          elsif error.is_a?(Errno::ETIMEDOUT)
+            error_params[:title] = "TIMEOUT_ERROR"
+          end
+        rescue Oj::ParseError
+        end
+
+        error_to_raise = Agx::Error.new(error.message, error_params)
+        raise error_to_raise
+      end
+
+      def current_token
+        if @token[:access_token].nil? || @token[:expires_at].nil?
+          new_token = api_token
+        else
+          oauth_token = OAuth2::AccessToken.new(
+            @client,
+            @token[:access_token],
+            {expires_at: @token[:expires_at]}
+          )
+          if Time.now.to_i + 180 >= @token[:expires_at] || oauth_token.expired?
+            new_token = api_token
+          else
+            new_token = oauth_token
+          end
+        end
+
+        new_token
+      end
+
+      def api_token
+        begin
+          new_token = @client.client_credentials.get_token(
+            {
+              'client_id' => @client_id,
+              'client_secret' => @client_secret,
+              'scope' => "referencedata"
+            },
+            { :header_format => 'Bearer' }
+          )
+        rescue => e
+          handle_error(e)
+        end
+
+        @token[:access_token] = new_token.token
+        @token[:expires_at] = new_token.expires_at
+
+        OAuth2::AccessToken.new @client, new_token.token
+      end
+
+      def set_client
+        @client = OAuth2::Client.new(
+          @client_id,
+          @client_secret,
+          site: @site,
+          token_url: @token_url
+        )
+      end
+
+    end
+  end
+end

data/lib/agx/content.rb

@@ -0,0 +1,6 @@
+require "agx/content/client"
+
+module Agx
+  module Content
+  end
+end

data/lib/agx/error.rb

@@ -0,0 +1,29 @@
+module Agx
+  class Error < StandardError
+    attr_reader :title, :detail, :body, :raw_body, :status_code
+
+    def initialize(message = "", params = {})
+      @title       = params[:title]
+      @detail      = message
+      @body        = params[:body]
+      @raw_body    = params[:raw_body]
+      @status_code = params[:status_code]
+
+      super(message)
+    end
+
+    def to_s
+      super + " " + instance_variables_to_s
+    end
+
+    private
+
+    def instance_variables_to_s
+      [:title, :detail, :body, :raw_body, :status_code].map do |attr|
+        attr_value = send(attr)
+
+        "@#{attr}=#{attr_value.inspect}"
+      end.join(", ")
+    end
+  end
+end

data/lib/agx/sync/client.rb

@@ -0,0 +1,169 @@
+module Agx
+  module Sync
+    class Client
+      attr_accessor :client_id, :client_secret, :site, :host, :authorize_url,
+        :token_url, :version, :sync_id, :access_token, :refresh_token, :token_expires_at,
+        :transaction_id
+
+      def initialize(client_id: nil, client_secret: nil, site: nil, host: nil,
+        authorize_url: nil, token_url: nil, version: nil, sync_id: nil,
+        access_token: nil, refresh_token: nil, token_expires_at: nil,
+        transaction_id: nil)
+        @client_id = client_id || ENV['AGX_SYNC_CLIENT_ID']
+        @client_secret = client_secret || ENV['AGX_SYNC_CLIENT_SECRET']
+        @site = site || "https://sync.agxplatform.com"
+        @host = host || "sync.agxplatform.com"
+        @authorize_url = authorize_url || "https://auth.agxplatform.com/Account/Authorize"
+        @token_url = token_url || "https://auth.agxplatform.com/Account/Token"
+        @version = version || "v3"
+        @sync_id = sync_id
+        @api_url = "#{@site}/api/#{@version}/Account/#{@sync_id}/"
+        @headers = {
+          'Content-Type' => "application/json",
+          'Accept' => "application/json",
+          'oauth-scopes' => "Sync",
+          'Host' => @host
+        }
+        @client = set_client
+        @token = {
+          access_token: access_token,
+          refresh_token: refresh_token,
+          expires_at: token_expires_at
+        }
+        @transaction_id = transaction_id
+      end
+
+      def get(resource, start_time = nil)
+        validate_sync_attributes
+
+        url = "#{@api_url}#{resource}?transactionId=#{@transaction_id}"
+        if !start_time.nil?
+          url = "#{@api_url}#{resource}?startTime=#{start_time}&transactionId=#{@transaction_id}"
+        end
+
+        begin
+          response = current_token.get(url, :headers => @headers)
+          parse_response(response.body)
+        rescue => e
+          handle_error(e)
+        end
+      end
+
+      def start_transaction
+        validate_credentials
+
+        if !@transaction_id.nil?
+          end_transaction
+        end
+        begin
+          transaction_request = current_token.get(
+            "#{@api_url}Transaction",
+            :headers => @headers
+          )
+          @transaction_id = Oj.load(transaction_request.body)
+        rescue => e
+          handle_error(e)
+        end
+
+        @transaction_id
+      end
+
+      def end_transaction
+        validate_credentials
+
+        begin
+          end_transaction_request = current_token.delete(
+            "#{@api_url}Transaction/#{@transaction_id}",
+            :headers => @headers
+          )
+        rescue => e
+          handle_error(e)
+        end
+      end
+
+      protected
+
+      def validate_credentials
+        unless @client_id && @client_secret
+          error = Agx::Error.new("agX Client Credentials Not Set", {title: "AGX_CREDENTIALS_ERROR"})
+          raise error
+        end
+      end
+
+      def validate_sync_attributes
+        validate_credentials
+
+        unless @sync_id && @transaction_id
+          error = Agx::Error.new("agX Sync Transaction Attributes Not Set", {title: "AGX_SYNC_ATTRIBUTES_ERROR"})
+          raise error
+        end
+      end
+
+      def parse_response(response_body)
+        parsed_response = nil
+
+        if response_body && !response_body.empty?
+          begin
+            parsed_response = Oj.load(response_body)
+          rescue Oj::ParseError
+            error = Agx::Error.new("Unparseable response: #{response_body}")
+            error.title = "UNPARSEABLE_RESPONSE"
+            error.status_code = 500
+            raise error
+          end
+        end
+
+        parsed_response
+      end
+
+      def handle_error(error)
+        error_params = {}
+
+        begin
+          if error.is_a?(OAuth2::Error) && error.response
+            error_params[:title] = "HTTP_#{error.response.status}_ERROR"
+            error_params[:status_code] = error.response.status
+            error_params[:raw_body] = error.response.body
+            error_params[:body] = Oj.load(error.response.body)
+          elsif error.is_a?(Errno::ETIMEDOUT)
+            error_params[:title] = "TIMEOUT_ERROR"
+          end
+        rescue Oj::ParseError
+        end
+
+        error_to_raise = Agx::Error.new(error.message, error_params)
+        raise error_to_raise
+      end
+
+      def current_token
+        new_token = OAuth2::AccessToken.new @client, @token[:access_token], {
+          expires_at: @token[:expires_at],
+          refresh_token: @token[:refresh_token]
+        }
+        if Time.now.to_i + 90 >= @token[:expires_at]
+          new_token = new_token.refresh!
+          @token[:access_token] = new_token.token
+          @token[:refresh_token] = new_token.refresh_token
+          @token[:expires_at] = new_token.expires_at
+        end
+
+        new_token
+      end
+
+      def set_client
+        @client = OAuth2::Client.new(
+          @client_id,
+          @client_secret, {
+            site: @site,
+            authorize_url: @authorize_url,
+            token_url: @token_url,
+            options: {
+              ssl: { ca_path: "/usr/lib/ssl/certs" }
+            }
+          }
+        )
+      end
+
+    end
+  end
+end

data/lib/agx/sync.rb

@@ -0,0 +1,6 @@
+require "agx/sync/client"
+
+module Agx
+  module Sync
+  end
+end

data/lib/agx/version.rb

@@ -0,0 +1,3 @@
+module Agx
+  VERSION = "0.1.0"
+end

data/lib/agx.rb

@@ -0,0 +1,10 @@
+require 'oauth2'
+require 'oj'
+
+require "agx/version"
+require "agx/error"
+require "agx/content"
+require "agx/sync"
+
+module Agx
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: agx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryce Johnston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby client for accessing SST Software's agX Platform APIs.
+email:
+- bjohnston@cropquest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- agx.gemspec
+- bin/console
+- bin/setup
+- lib/agx.rb
+- lib/agx/content.rb
+- lib/agx/content/client.rb
+- lib/agx/error.rb
+- lib/agx/sync.rb
+- lib/agx/sync/client.rb
+- lib/agx/version.rb
+homepage: https://github.com/CropQuest/agx-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Ruby client for accessing agX Platform APIs.
+test_files: []
+has_rdoc: