aaww 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f01ae663aa7e27fab44602d9b679da74357ffd29
-  data.tar.gz: bbac4615a80359de068e0b3fc52eac084c720bad
+  metadata.gz: 5e5ad2f487e73f48de2d2d86cbba1f06590333d0
+  data.tar.gz: 0b053cac59c6dc049d14cad04bc23e3eca90d332
 SHA512:
-  metadata.gz: f941f269adb4875568c97147f148d2ab37069fcdec3b027874b11351ab00b057e0ece15402f98202c1574fe28ef47ecbe6986c3fc16ffc40f55a61c8deeb0d36
-  data.tar.gz: 7bc829032135d5899db31d279c764c761e61107dba9c043d1994906a3b2bf3f88a1395dd8f07efa0b66d7c9abf7a1aed3315b42846507dbc19981ae61a1e5036
+  metadata.gz: 109495be5ca51e793a649475a84d3147c2de8130012e94ef0abaf17a84f9de1ace09effc3edd3d4b2dacd797014fbc9e5716438d6f4d2afe3069698c40c8b50a
+  data.tar.gz: ab1a834ed942ab94382a59b1028d318c8822ae9c53d9537990fb320cadca386cdc043878ade1cd5095e331519dff36653c5c3fb28659feeac73cea0027cdfacb

data/README.md

@@ -42,6 +42,24 @@ Then, you can access the token links created by Authentise with:
     transaction.link
     transaction.ssl_link
 
+### Checking status
+
+You can access the status of the current transaction with:
+
+    transaction.status
+
+This is the status of the last API call. If you want to check the current print
+status, call `check_print_status!`. Then you can see if there's any error or
+progress:
+
+    transaction.check_print_status!
+    transaction.status.ok? # true
+    transaction.progress.minutes_left # 15
+
+Be careful with making consecutive calls to `check_print_status!` without
+waiting at least 15 seconds, because it can be interpreted as
+[abuse](http://authentise.com/api-start#status).
+
 ## Contributing
 
 1. Fork it ( https://github.com/lainventoria/aaww/fork )

data/lib/aaww.rb

@@ -2,6 +2,8 @@ require 'httmultiparty'
 require 'active_model'
 require 'aaww/version'
 require 'aaww/transaction'
+require 'aaww/status'
+require 'aaww/progress'
 
 module Aaww
   include HTTMultiParty

data/lib/aaww/progress.rb

@@ -0,0 +1,12 @@
+module Aaww
+  class Progress
+    include ActiveModel::Model
+
+    attr_accessor :minutes_left, :printing_percentage, :message,
+                  :printing_job_status_name
+
+    def any?
+      !printing_percentage.nil?
+    end
+  end
+end

data/lib/aaww/status.rb

@@ -0,0 +1,15 @@
+module Aaww
+  class Status
+    include ActiveModel::Model
+
+    attr_accessor :code, :description, :extended_description
+
+    def error?
+      code == 'error'
+    end
+
+    def ok?
+      code == 'ok'
+    end
+  end
+end

data/lib/aaww/transaction.rb

@@ -1,14 +1,19 @@
 module Aaww
   class Transaction
     include ActiveModel::Model
+    extend Forwardable
 
-    attr_accessor :key, :token, :file, :email, :value, :job_id, :link, :ssl_link
+    attr_accessor :key, :token, :file, :email, :value, :job_id, :link,
+                  :ssl_link, :status, :progress
+
+    def_delegators :status, :ok?, :error?
 
     # Creates a single unique token for this transaction
     # Returns Token
     # GET /api3/api_create_partner_token?api_key={key}
     def create_token
       response = Aaww.get '/api3/api_create_partner_token', query: { api_key: key }
+      self.status = Status.new response['status']
       self.token = response['data']['token']
       response
     end
@@ -29,6 +34,7 @@ module Aaww
       create_token if token.nil?
 
       response = Aaww.post '/api3/api_upload_partner_stl', query: upload_query
+      self.status = Status.new response['status']
       self.link = response['data']['token_link']
       self.ssl_link = response['data']['ssl_token_link']
       response
@@ -42,5 +48,18 @@ module Aaww
         partner_job_id: job_id,
         stl_file: file }.reject { |_, value| value.nil? }
     end
+
+    # Returns a detailed print status for a specific token
+    # Returns Print Status
+    # GET /api3/api_get_partner_print_status?api_key={key}&token={token}"
+    # TODO enforce 15 seconds API restriction
+    def check_print_status!
+      if token
+        response = Aaww.get '/api3/api_get_partner_print_status', query: { api_key: key, token: token }
+        self.status = Status.new response['status']
+        self.progress = Progress.new response['data']
+        response
+      end
+    end
   end
 end

data/lib/aaww/version.rb

@@ -1,3 +1,3 @@
 module Aaww
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/test/api_responses/print_status_with_print_not_started.yml

@@ -0,0 +1,113 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://widget.sendshapes.com:3443/api3/api_create_partner_token?api_key=fake_test_key
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Fri, 30 Jan 2015 21:44:13 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"data":{"token":"fake_test_token"},"status":{"code":"ok"}}'
+    http_version: 
+  recorded_at: Fri, 30 Jan 2015 21:39:20 GMT
+- request:
+    method: post
+    uri: https://widget.sendshapes.com:3443/api3/api_upload_partner_stl
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - multipart/form-data; boundary=-----------RubyMultipartPost
+      Content-Length:
+      - '1320'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Fri, 30 Jan 2015 21:44:14 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"status":{"code":"ok"},"data":{"token_link":"http:\/\/tokens.sendshapes.com\/?token=fake_test_token","ssl_token_link":"https:\/\/tokens.sendshapes.com\/?token=fake_test_token"}}'
+    http_version: 
+  recorded_at: Fri, 30 Jan 2015 21:39:21 GMT
+- request:
+    method: get
+    uri: https://widget.sendshapes.com:3443/api3/api_get_partner_print_status?api_key=fake_test_key&token=fake_test_token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Fri, 30 Jan 2015 21:44:15 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"status":{"description":"System error","code":"error","extended_description":"Reciever
+        job 6110 is not yet available\n"}}'
+    http_version: 
+  recorded_at: Fri, 30 Jan 2015 21:39:22 GMT
+recorded_with: VCR 2.9.3

data/test/api_responses/print_status_without_print.yml

@@ -0,0 +1,74 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://widget.sendshapes.com:3443/api3/api_create_partner_token?api_key=fake_test_key
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Fri, 30 Jan 2015 21:34:46 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"status":{"code":"ok"},"data":{"token":"fake_test_token"}}'
+    http_version: 
+  recorded_at: Fri, 30 Jan 2015 21:29:52 GMT
+- request:
+    method: get
+    uri: https://widget.sendshapes.com:3443/api3/api_get_partner_print_status?api_key=fake_test_key&token=fake_test_token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Fri, 30 Jan 2015 21:34:47 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"status":{"description":"System error","extended_description":"token
+        does not have print order associated\n","code":"error"}}'
+    http_version: 
+  recorded_at: Fri, 30 Jan 2015 21:29:53 GMT
+recorded_with: VCR 2.9.3

data/test/minitest_helper.rb

@@ -4,6 +4,7 @@ require 'aaww'
 require 'minitest/autorun'
 require 'webmock/minitest'
 require 'vcr'
+require 'pry'
 
 VCR.configure do |c|
   c.cassette_library_dir = 'test/api_responses'

data/test/test_progress.rb

@@ -0,0 +1,19 @@
+require 'minitest_helper'
+
+describe Aaww::Progress do
+  describe 'without progress' do
+    subject { Aaww::Progress.new }
+
+    it 'doesnt show progress' do
+      subject.wont_be :any?
+    end
+  end
+
+  describe 'with progress' do
+    subject { Aaww::Progress.new printing_percentage: '20' }
+
+    it 'show progress' do
+      subject.must_be :any?
+    end
+  end
+end

data/test/test_status.rb

@@ -0,0 +1,27 @@
+require 'minitest_helper'
+
+describe Aaww::Status do
+  describe 'without errors' do
+    subject { Aaww::Status.new code: 'ok' }
+
+    it 'is ok' do
+      subject.must_be :ok?
+    end
+
+    it 'wont have errors' do
+      subject.wont_be :error?
+    end
+  end
+
+  describe 'with errors' do
+    subject { Aaww::Status.new code: 'error' }
+
+    it 'wont be ok' do
+      subject.wont_be :ok?
+    end
+
+    it 'has errors' do
+      subject.must_be :error?
+    end
+  end
+end

data/test/test_transaction.rb

@@ -16,7 +16,11 @@ describe Aaww::Transaction do
 
     it 'returns the response' do
       @response.must_be_instance_of Hash
-      @response['status']['code'].must_equal 'ok'
+    end
+
+    it 'saves the status' do
+      subject.status.must_be_instance_of Aaww::Status
+      subject.must_be :ok?
     end
 
     it 'saves the token for future use' do
@@ -34,7 +38,11 @@ describe Aaww::Transaction do
 
     it 'returns the response' do
       @response.must_be_instance_of Hash
-      @response['status']['code'].must_equal 'ok'
+    end
+
+    it 'saves the status' do
+      subject.status.must_be_instance_of Aaww::Status
+      subject.must_be :ok?
     end
 
     it 'saves the file' do
@@ -80,6 +88,11 @@ describe Aaww::Transaction do
         @response['status']['code'].must_equal 'ok'
       end
 
+      it 'saves the status' do
+        subject.status.must_be_instance_of Aaww::Status
+        subject.must_be :ok?
+      end
+
       it 'saves the link' do
         subject.link.must_equal @response['data']['token_link']
       end
@@ -108,4 +121,63 @@ describe Aaww::Transaction do
       end
     end
   end
+
+  describe 'check_print_status!' do
+    subject do
+      Aaww::Transaction.new key: 'fake_test_key',
+        file: sample_stl, email: 'email@example.com', value: 1, job_id: 69
+    end
+
+    describe 'without print job' do
+      before do
+        VCR.use_cassette 'print_status_without_print' do
+          subject.create_token
+          @response = subject.check_print_status!
+        end
+      end
+
+      it 'fails' do
+        @response.must_be_instance_of Hash
+      end
+
+      it 'saves the status' do
+        subject.status.must_be_instance_of Aaww::Status
+        subject.must_be :error?
+      end
+
+      it 'doesnt show any progress' do
+        subject.progress.must_be_instance_of Aaww::Progress
+        subject.progress.wont_be :any?
+      end
+
+      it 'gives an error message' do
+        subject.status.description.must_equal @response['status']['description']
+        subject.status.extended_description.must_equal @response['status']['extended_description']
+      end
+    end
+
+    describe 'with print job not started' do
+      before do
+        VCR.use_cassette 'print_status_with_print_not_started' do
+          subject.upload!
+          @response = subject.check_print_status!
+        end
+      end
+
+      it 'saves the status' do
+        subject.status.must_be_instance_of Aaww::Status
+        subject.must_be :error?
+      end
+
+      it 'doesnt show any progress' do
+        subject.progress.must_be_instance_of Aaww::Progress
+        subject.progress.wont_be :any?
+      end
+
+      it 'gives an error message' do
+        subject.status.description.must_equal @response['status']['description']
+        subject.status.extended_description.must_equal @response['status']['extended_description']
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aaww
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - La Inventoría
@@ -137,13 +137,19 @@ files:
 - Rakefile
 - aaww.gemspec
 - lib/aaww.rb
+- lib/aaww/progress.rb
+- lib/aaww/status.rb
 - lib/aaww/transaction.rb
 - lib/aaww/version.rb
 - test/api_responses/create_token.yml
+- test/api_responses/print_status_with_print_not_started.yml
+- test/api_responses/print_status_without_print.yml
 - test/api_responses/upload.yml
 - test/fixtures/sample.stl
 - test/minitest_helper.rb
 - test/test_aaww.rb
+- test/test_progress.rb
+- test/test_status.rb
 - test/test_transaction.rb
 homepage: http://github.com/lainventoria/aaww
 licenses:
@@ -171,8 +177,12 @@ specification_version: 4
 summary: A simple Authentise API Wrapper
 test_files:
 - test/api_responses/create_token.yml
+- test/api_responses/print_status_with_print_not_started.yml
+- test/api_responses/print_status_without_print.yml
 - test/api_responses/upload.yml
 - test/fixtures/sample.stl
 - test/minitest_helper.rb
 - test/test_aaww.rb
+- test/test_progress.rb
+- test/test_status.rb
 - test/test_transaction.rb