agx 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6757c8bcbacdc7d646a5378085660012c46155f9
-  data.tar.gz: b31be8a6b2885075817a20937d03a5d218f3878a
+  metadata.gz: 358ca46754287a4f484a20f453f35462eb7596ed
+  data.tar.gz: fbb5693193f3bc99cd8119b991fe8373bf15f7fb
 SHA512:
-  metadata.gz: 4b6e5172e7afec61d020a279302a47fba64a7ef77ea0a846d17bb0b71be4bfe1c697134fbb3e057472febdb7de4ade587caac2f6435f7987744592f2c7cfaac4
-  data.tar.gz: 1df9291443ea6a451a448e0df9daf9b04421adc57c84f880448e70ab08784318f36a77a68a0c4541e4aa55c805d3cba90857a404f8a0e44b963ff422c3fd3db8
+  metadata.gz: 2070b7b7e2ea87526d16e490bf92eb7c257fe5df80fcdd8c298c302bb28128642379f7455e217aceae9a3c0475d83bfb5d4db8a0dad29399bd836b98fbb93d03
+  data.tar.gz: 2c5d0292b4efc172cbf850ce4d49874a12bf186983f5dfadf9af7549a154080a541de4639b01173b3a4a9998aae331665944724dbca49673a8be1d3a8fccd23a

data/README.md

@@ -49,11 +49,11 @@ weeds = @agx_content_client.get("Weed", {publishDate: date.to_s})
 
 ### agX Sync API
 
-Setup agX Sync v4 Client (OAuth 2.0 / OpenID Connect 1.0 Authorization Code Flow)
+Setup agX Sync Client (OAuth 2.0 / OpenID Connect 1.0 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
+a user to agX with required scopes through the authorization code grant flow process
+and have persisted their sync ID, access token, refresh token, and access token
 expiration timestamp.***
 
 ```ruby
@@ -65,7 +65,7 @@ expiration timestamp.***
   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,
+  transaction_id: "agx_user_previous_transaction_id", # optional
   prod: true # optional, false for QA
 )
 ```
@@ -97,17 +97,48 @@ farms = @agx_sync_client.get("Grower/#{grower.guid}/Farm", last_sync_date.to_s)
 user_transaction_id = nil
 ```
 
+### agX Pictures API
+
+Setup agX Pictures Client
+
+```ruby
+@agx_pictures_client = Agx::Pictures::Client.new(
+  client_id: "your_client_id",
+  client_secret: "your_client_secret",
+  version: "v1",  # 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",
+  filepath: "/path/to/pictures/",
+  prod: true # optional, false for QA
+)
+```
+
+Make get requests for Pictures API images and metadata
+
+***Currently only get requests are supported***
+```ruby
+
+# Get metadata
+image_meta = @agx_pictures_client.get_metadata("661ee0c0-0cbc-4a7b-be39-1a9de49acc86")
+
+# Get image and save to {filepath}/{sync_id}_{picture_id}.jpeg
+image = @agx_pictures_client.get("661ee0c0-0cbc-4a7b-be39-1a9de49acc86")
+# => "/path/to/pictures/7_661ee0c0-0cbc-4a7b-be39-1a9de49acc86.jpeg"
+```
+
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/beaorn/agx-ruby.
 
 
 ## License
 
-The gem is available as open source under the terms of the MIT License (see [LICENSE.txt](https://github.com/CropQuest/agx-ruby/blob/master/LICENSE.txt))
+The gem is available as open source under the terms of the MIT License (see [LICENSE.txt](https://github.com/beaorn/agx-ruby/blob/master/LICENSE.txt))
 
 [agX](http://www.agxplatform.com/) is a registered trademark of [SST Software](http://www.sstsoftware.com/).

data/agx.gemspec

@@ -7,11 +7,11 @@ Gem::Specification.new do |spec|
   spec.name          = "agx"
   spec.version       = Agx::VERSION
   spec.authors       = ["Bryce Johnston"]
-  spec.email         = ["bjohnston@cropquest.com"]
+  spec.email         = ["bryce@agdeveloper.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.homepage      = "https://github.com/beaorn/agx-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/agx.rb

@@ -5,6 +5,7 @@ require "agx/version"
 require "agx/error"
 require "agx/content"
 require "agx/sync"
+require "agx/pictures"
 
 module Agx
 end

data/lib/agx/pictures.rb

@@ -0,0 +1,6 @@
+require "agx/pictures/client"
+
+module Agx
+  module Pictures
+  end
+end

data/lib/agx/pictures/client.rb

@@ -0,0 +1,123 @@
+module Agx
+  module Pictures
+    class Client
+      attr_accessor :client_id, :client_secret, :site, :host, :authorize_url,
+        :token_url, :version, :sync_id, :access_token, :refresh_token, :token_expires_at
+
+      def initialize(client_id: nil, client_secret: nil, version: nil,
+        sync_id: nil, access_token: nil, refresh_token: nil,
+        token_expires_at: nil, prod: true, filepath: nil)
+        domain = (prod ? "agxplatform.com" : "qaagxplatform.com")
+        @client_id = client_id || ENV['AGX_SYNC_CLIENT_ID']
+        @client_secret = client_secret || ENV['AGX_SYNC_CLIENT_SECRET']
+        @site = "https://pictures.#{domain}"
+        @host = host || "pictures.#{domain}"
+        @authorize_url = "https://auth.#{domain}/identity/connect/Authorize"
+        @token_url = "https://auth.#{domain}/identity/connect/Token"
+        @version = version || "v1"
+        @sync_id = sync_id
+        @api_url = "#{@site}/api/#{@version}/picture/"
+        @filepath = filepath
+        @headers = {
+          'oauth-scopes' => "Sync",
+          'Host' => @host
+        }
+        @client = set_client
+        @token = {
+          access_token: access_token,
+          refresh_token: refresh_token,
+          expires_at: token_expires_at
+        }
+      end
+
+      def get(id)
+        url = "#{@api_url}#{id}"
+        begin
+          response = current_token.get(url, :headers => @headers)
+          filename = "#{@filepath}/#{@sync_id}_#{id}.jpeg"
+          File.open(filename, 'wb') { |fp| fp.write(response.body) }
+        rescue => e
+          handle_error(e)
+        end
+      end
+
+      def get_metadata(id)
+        url = "#{@api_url}#{id}/metadata"
+        begin
+          response = current_token.get(url, :headers => @headers)
+          parse_response(response.body)
+        rescue => e
+          handle_error(e)
+        end
+      end
+
+      protected
+
+      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/client.rb

@@ -15,7 +15,7 @@ module Agx
         @host = host || "sync.#{domain}"
         @authorize_url = "https://auth.#{domain}/identity/connect/Authorize"
         @token_url = "https://auth.#{domain}/identity/connect/Token"
-        @oic_config_url = "https://auth.#{domain}/.well-known/openid- configuration"
+        @oic_config_url = "https://auth.#{domain}/.well-known/openid-configuration"
         @version = version || "v4"
         @sync_id = sync_id
         @api_url = "#{@site}/api/#{@version}/Account/#{@sync_id}/"

data/lib/agx/version.rb

@@ -1,3 +1,3 @@
 module Agx
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agx
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Bryce Johnston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-20 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -82,7 +82,7 @@ dependencies:
         version: '3.0'
 description: Ruby client for accessing SST Software's agX Platform APIs.
 email:
-- bjohnston@cropquest.com
+- bryce@agdeveloper.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -101,10 +101,12 @@ files:
 - lib/agx/content.rb
 - lib/agx/content/client.rb
 - lib/agx/error.rb
+- lib/agx/pictures.rb
+- lib/agx/pictures/client.rb
 - lib/agx/sync.rb
 - lib/agx/sync/client.rb
 - lib/agx/version.rb
-homepage: https://github.com/CropQuest/agx-ruby
+homepage: https://github.com/beaorn/agx-ruby
 licenses:
 - MIT
 metadata: {}
@@ -124,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby client for accessing agX Platform APIs.