cloudprint 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30d1e64ab2141fea3831325ef8bbd97a1eef1981
-  data.tar.gz: deec16fec77660a2745f10c24cf12930c893a02d
+  metadata.gz: 9941fa5e2ef6dad3668a1b587081fd47d8212624
+  data.tar.gz: 820a436e238805a68540c780d8b8aacba356218c
 SHA512:
-  metadata.gz: 4c7e55df00f612b8f8954755310f7eb101ba0019a735d3dd284a6911d4a526e6fe2f25aef2e7bb02da8c5d8feffa7b2c8de6f9e16320507ddf30ef2f9073016b
-  data.tar.gz: 2c845328675320f26d317c2246e5d5b759d8de702ceb3481dad245fb559c4a4ea21bb0a4d2ddbbd34ee080d96c1cb54ceea375dee07e164de9d5bf409737d383
+  metadata.gz: 4697fc8d0a26b315eb253957ff2ed37ec63cbed534dbfd9e0e7829aa8665cd452a7ae3ba95952150fba5b481db75eeda24822527a201cd1e1812c3da9155cabb
+  data.tar.gz: aa1a0a977ba79526137a8690d5a8aa41ed98b46a5a405f2b4a6b258eda82c8f1e1350bcc099d73751fb7a8b2dcb480a4c6e315ca07206c54f8b3507f90f4635e

data/.gitignore

@@ -4,3 +4,4 @@
 Gemfile.lock
 pkg/*
 tags
+vendor/

data/Gemfile

@@ -2,6 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in cloudprint.gemspec
 gemspec
-group :development do
-  gem 'mocha', require: false
-end

data/README.md

@@ -1,71 +1,50 @@
-## Cloudprint [![Build Status](https://travis-ci.org/minciue/cloudprint.png?branch=master)](https://travis-ci.org/minciue/cloudprint)
+# Cloudprint [![Build Status](https://travis-ci.org/thegengen/cloudprint.svg?branch=master)](https://travis-ci.org/thegengen/cloudprint)
 
-Cloudprint is a Ruby library for interacting with Google's Cloud Print service,
-a technology that allows you to print over the web from anywhere to any
-printer.
+Cloudprint is a Ruby library for interacting with Google's Cloud Print service, a technology that allows you to print over the web from anywhere to any printer.
 
-### Setting things up.
-To start using cloudprint, you first need to add it to your Gemfile, with an
-entry such as this.
+## Setting things up.
+To start using cloudprint, you first need to add it to your Gemfile, with an entry such as this:
 
 ```ruby
 gem 'cloudprint'
 ```
 
-Afterwards, run 
-```
-bundle
-```
-
-Next, you'll need to authenticate your users with Google Cloud Print. Cloud
-Print uses OAuth2 as an authentication mechanism.
+Afterwards, run `bundle install` 
 
-First, you need to register your application within the Google Console. To do
-that, go to [https://cloud.google.com/console](https://cloud.google.com/console) 
-. Doing this will provide you with two things that will be needed to manage
-your users' printers: a client ID and a client secret.  
+Next, you'll need to authenticate your users with Google Cloud Print. Cloud Print uses OAuth2 as an authentication mechanism.
 
-### Authenticating your users.
-Once you've registered your application, you will need to send your users to a
-URL where they can allow your application to manage their printer.
+First, you need to register your application within the Google Console. To do that, go to [https://cloud.google.com/console](https://cloud.google.com/console). Doing this will provide you with two things that will be needed to manage your users' printers: a client ID and a client secret.
 
-Details on how such a URL can be built can be found here:
-[https://developers.google.com/accounts/docs/OAuth2WebServer#formingtheurl](https://developers.google.com/accounts/docs/OAuth2WebServer#formingtheurl)
+## Authenticating your users.
+Once you've registered your application, you will need to send your users to a URL where they can allow your application to manage their printer. You will also need to specify a URL *of yours* where they will be sent back after giving you access.
 
-Eventually, the cloudprint gem will generate these URLs for you, but for now
-you're on your own. Sorry about that.
-
-Your users will be asked to sign into their Google Account and to enable your
-app to manage their printer. Later on, they can then set up their printer from
-the Google Cloud Print interface.
+```ruby
+client = CloudPrint::Client.new(client_id: 'your_app_id', client_secret: 'your_app_secret')
+redirect_url = 'http://your.app/redirect_uri'
+client.auth.generate_url(redirect_url)
+```
 
-Once users authorize your application, they will be sent back to a URL you
-specify which will have an extra parameter named 'code' attached to it.
-You then exchange this code for a refresh token.
-Instructions on how to get a refresh token can be found here:
-[https://developers.google.com/accounts/docs/OAuth2WebServer#handlingtheresponse](https://developers.google.com/accounts/docs/OAuth2WebServer#handlingtheresponse)
+When they come, their request to your URL will have an extra parameter named 'code' attached to it. You then exchange this code for a refresh token. Note that you also have to include the redirect URL which you specified above.
 
-With this in place (and with the user's printer set up from the CloudPrint UI)
-you now have everything you need to send print jobs to this printer.
+```ruby
+code = params[:code]
+token = client.auth.generate_token(code, redirect_url)
+```
 
-### Printing
-First, you need to initialize a client with the data you just got from the
-user. You will use this client object to interact with CloudPrint on behalf
-of the user.
+The client is all set to start using the URI, but you will want to store this refresh token so you can get access again at a later time. Subsequently, you can set the refresh token on `Cloudprint::Client` instances yourself.
 
 ```ruby
 client = CloudPrint::Client.new(
   refresh_token: 'refresh_token',
-  client_id: 'client_id',
-  client_secret: 'client_secret',
-  callback_url: 'callback_url'
+  client_id: 'your_app_id',
+  client_secret: 'your_app_secret',
 )
 ```
 
-Printing with the cloudprint gem is done with two kinds of objects. 
-`CloudPrint::Printer` 
-objects represent printers your users have set up in their CloudPrint accounts.
-You then ask these objects to print things like this:
+With this in place — and with the user's printer set up from the CloudPrint UI — you now have everything you need to start using their printer.
+
+## Printing
+Printing with the cloudprint gem is done with two kinds of objects. `CloudPrint::Printer` objects represent printers your users have set up in their CloudPrint accounts. You then ask these objects to print things like this:
 
 ```ruby
 # Get a list of all the printers this client can talk to.
@@ -80,18 +59,11 @@ my_printer = client.printers.find('printer_id')
 my_printer.print(content: "<h1>Hello World</h1>", content_type: "text/html")
 ```
 
-Here's where the second kind of object comes in. If your content has been
-succesfully sent to the printer, the cloudprint gem will return a
-`CloudPrint::PrintJob` object. Among other things, this object will provide you
-with an ID for the print job and, a status code, and an error code if anything
-happened that prevented your document from getting printed.
+Here's where the second kind of object comes in. If your content has been succesfully sent to the printer, the cloudprint gem will return a `CloudPrint::PrintJob` object. Among other things, this object will provide you with an ID for the print job and, a status code, and an error code if anything happened that prevented your document from getting printed.
 
-Most of the time, the PrintJob object that your print() call will return has a
-status of `IN_PROGRESS` or `QUEUED`.
+Most of the time, the PrintJob object that your print() call will return has a status of `IN_PROGRESS` or `QUEUED`.
 
-If your application can simply wait for the job, you can call refresh! on your
-print job until its status changes. If not, you can store the ID and fetch the
-print job at a later time to verify its status.
+If your application can simply wait for the job, you can call refresh! on your print job until its status changes. If not, you can store the ID and fetch the print job at a later time to verify its status.
 
 ```ruby
 my_job = client.print_jobs.find('job_id')
@@ -106,10 +78,8 @@ You can also delete a job, after it has finished.
 my_job.delete!
 ```
 
-### Testing
-For your testing needs, cloudprint objects can be stubbed at will and
-initializing them does not require a connection. For example, to stub a print()
-call with the shoulda library, one would do this:
+## Testing
+For your testing needs, cloudprint objects can be stubbed at will and initializing them does not require a connection. For example, to stub a print() call with the shoulda library, one would do this:
 
 ```ruby
 my_printer = CloudPrint::Printer.new(id: 'id', status: 'OK', name: 'test_printer', display_name: 'Test Printer'
@@ -117,5 +87,5 @@ my_job = CloudPrint::PrintJob.new({}) # see the PrintJob class for what this has
 my_printer.stubs(:print).returns(my_job)
 ```
 
-### More help
+## More help
 Please submit an issue via GitHub if you need more help with the cloudprint gem.

data/lib/cloudprint.rb

@@ -5,6 +5,7 @@ require "json"
 
 require "cloudprint/version"
 require "cloudprint/client"
+require "cloudprint/auth"
 require "cloudprint/printer_collection"
 require "cloudprint/printer"
 require "cloudprint/connection"

data/lib/cloudprint/auth.rb

@@ -0,0 +1,35 @@
+require "uri"
+
+module CloudPrint
+  class Auth
+    def initialize(client, options = {})
+      @client = client
+      @access_type = options[:access_type] || 'offline'
+    end
+
+    def generate_url(redirect_uri)
+      URI::HTTPS.build(
+        host: 'accounts.google.com',
+        path: '/o/oauth2/v2/auth',
+        query: URI.encode_www_form(url_params(redirect_uri))
+      ).to_s
+    end
+
+    def generate_token(code, redirect_uri)
+      full_token = @client.oauth_client.auth_code.get_token(code, redirect_uri: redirect_uri)
+      @client.refresh_token = full_token.refresh_token
+    end
+
+    private
+
+    def url_params(redirect_uri)
+      {
+        response_type: 'code',
+        scope: 'https://www.googleapis.com/auth/cloudprint',
+        client_id: @client.client_id,
+        access_type: @access_type,
+        redirect_uri: redirect_uri
+      }
+    end
+  end
+end

data/lib/cloudprint/client.rb

@@ -14,11 +14,16 @@ module CloudPrint
       @client_id = options[:client_id]
       @client_secret = options[:client_secret]
       @callback_url = options[:callback_url]
+      @access_type = options[:access_type]
       @connection = Connection.new(self)
       @printers = PrinterCollection.new(self)
       @print_jobs = PrintJobCollection.new(self)
     end
 
+    def auth
+      @auth ||= CloudPrint::Auth.new(self, access_type: @access_type)
+    end
+
     def access_token
       (access_token_valid? && @access_token || renew_access_token!).token
     end
@@ -32,18 +37,21 @@ module CloudPrint
       @access_token.is_a?(OAuth2::AccessToken) && !@access_token.token.to_s.strip.empty? && !@access_token.expired?
     end
 
+    def oauth_client
+      @oauth_client ||= OAuth2::Client.new(
+        client_id, client_secret,
+        :authorize_url => "/o/oauth2/auth",
+        :token_url => "/o/oauth2/token",
+        :access_token_url => "/o/oauth2/token",
+        :site => 'https://accounts.google.com/'
+      )
+    end
+
     private
 
     def renew_access_token!
       @access_token = OAuth2::AccessToken.new(oauth_client, "", :refresh_token => refresh_token).refresh!
     end
 
-    def oauth_client
-      @oauth_client ||= OAuth2::Client.new(client_id, client_secret,
-        :authorize_url => "/o/oauth2/auth",
-        :token_url => "/o/oauth2/token",
-        :access_token_url => "/o/oauth2/token",
-        :site => 'https://accounts.google.com/')
-    end
   end
 end

data/lib/cloudprint/print_job_collection.rb

@@ -2,11 +2,11 @@ module CloudPrint
   class PrintJobCollection
 
     attr_accessor :client
-    
+
     def initialize client
       @client = client
     end
-    
+
     def find(jobid)
       job = find_by_id(jobid)
       return nil if job.nil?
@@ -26,7 +26,9 @@ module CloudPrint
     end
 
     def find_by_id(id)
-      fetch_jobs.select{ |job| job['id'] == id }.first
+      response = client.connection.post('/job', :jobid => id) || {}
+      return nil if response.nil? || response["job"].nil?
+      response["job"]
     end
 
     private

data/lib/cloudprint/printer.rb

@@ -20,7 +20,14 @@ module CloudPrint
     def print(options)
       content = options[:content]
       method = content.is_a?(IO) || content.is_a?(StringIO) || content.is_a?(Tempfile) ? :multipart_post : :post
-      response = client.connection.send(method, '/submit', :printerid => self.id, :title => options[:title], :content => options[:content], :ticket => options[:ticket].to_json, :contentType => options[:content_type]) || {}
+      params = {
+        printerid: self.id,
+        title: options[:title],
+        content: options[:content],
+        contentType: options[:content_type]
+      }
+      params[:ticket] = options[:ticket].to_json if options[:ticket] && options[:ticket] != ''
+      response = client.connection.send(method, '/submit', params) || {}
       return nil if response.nil? || response["job"].nil?
       client.print_jobs.new_from_response response["job"]
     end

data/lib/cloudprint/version.rb

@@ -1,3 +1,3 @@
 module Cloudprint
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/test/auth_test.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class AuthTest < Minitest::Test
+  def setup
+    stub_access_token
+    @client = CloudPrint::Client.new(client_id: 'client_1234', client_secret: 'supersecret')
+  end
+
+  should 'generate a URI that points to accounts.google.com' do
+    assert_match 'accounts.google.com', generated_url
+  end
+
+  should 'generate a URI that asks for a code' do
+    assert_match 'response_type=code', generated_url
+  end
+
+  should 'generate a URI that asks for access to Cloudprint' do
+    assert_match '%2Fauth%2Fcloudprint', generated_url
+  end
+
+  should 'generate a URI that asks for offline access' do
+    assert_match 'access_type=offline', generated_url
+  end
+
+  should 'generate a URI that will redirect us to example.com' do
+    assert_match 'redirect_uri=http%3A%2F%2Fexample.com', generated_url
+  end
+
+  should 'generate a URI that contains the client_id' do
+    assert_match 'client_id=client_1234', generated_url
+  end
+
+  should 'generate a refresh token when passed in a code' do
+    mock_oauth_code = mock('oauth_code')
+    mock_oauth_code.stubs(:get_token).returns(mock_refresh_token)
+
+    @client.oauth_client.stubs(auth_code: mock_oauth_code)
+    token = @client.auth.generate_token('google_code', "http://example.com")
+
+    assert_equal "random_refresh_token", token
+    assert_equal "random_refresh_token", @client.refresh_token
+  end
+
+  private
+
+  def generated_url
+    @client.auth.generate_url("http://example.com")
+  end
+end

data/test/connection_test.rb

@@ -1,4 +1,4 @@
-require "helper"
+require 'helper'
 
 class ConnectionTest < Minitest::Test
   def setup

data/test/helper.rb

@@ -29,6 +29,12 @@ class Minitest::Test
     mock
   end
 
+  def mock_refresh_token
+    mock = mock("refresh_token")
+    mock.stubs(refresh_token: "random_refresh_token")
+    mock
+  end
+
   def stub_http
     mock = mock_http()
     Net::HTTP.stubs(:new).returns(mock)

data/test/print_job_test.rb

@@ -7,24 +7,23 @@ class PrintJobTest < Minitest::Test
     stub_connection
   end
 
-  should "find a job" do
-    fake_connection.stubs(:get).with('/jobs').returns(jobs_response)
+  should 'find a job' do
+    fake_connection.expects(:post).with('/job', {:jobid => "job_id"}).returns(real_job_hash)
     assert @client.print_jobs.find('job_id').is_a?(CloudPrint::PrintJob)
   end
 
   should 'perform a remote request when finding a job' do
-    fake_connection.expects(:get).with('/jobs').returns({})
-
+    fake_connection.expects(:post).with('/job', {:jobid => "job_id"}).returns(real_job_hash)
     @client.print_jobs.find('job_id')
   end
 
   should 'gets the job details' do
-    fake_connection.stubs(:get).with('/jobs').returns(jobs_response)
+    fake_connection.expects(:post).with('/job', {:jobid => "job_id"}).returns(real_job_hash)
     job = @client.print_jobs.find('job_id')
 
     assert_equal 'job_id', job.id
-    assert_equal 'status', job.status
-    assert_equal 'Error', job.error_code
+    assert_equal 'mocked_status', job.status
+    assert_equal '', job.error_code
     assert_equal 'printer_id', job.printer_id
     assert_equal 'Job Title', job.title
     assert_equal 'image/jpeg', job.content_type
@@ -154,4 +153,54 @@ class PrintJobTest < Minitest::Test
       ]
     }
   end
+
+  def real_job_hash
+    {
+      "success" => true,
+      "request" => {
+        "time" => "0",
+        "params" => {
+          "jobid" => [
+            "job_id"
+          ]
+        },
+        "user" => "santa@claus.com",
+        "users" => [
+          "santa@claus.com"
+        ]
+      },
+      "xsrf_token" => "AIp06DiNzjnfseYdqxujmG5P5oDpPh3N_A:1465433435813",
+      "job" => {
+        "ticketUrl" => "https://www.google.com/cloudprint/ticket?jobid=job_id",
+        "printerType" => "GOOGLE",
+        "printerName" => "Brother HL-L2380DW series",
+        "errorCode" => "",
+        "updateTime" => "1349722237676",
+        "title" => "Job Title",
+        "message" => "A message.",
+        "ownerId" => "santa@claus.com",
+        "tags" => [
+          "^own"
+        ],
+        "uiState" => {
+          "summary" => "DONE"
+        },
+        "numberOfPages" => 1,
+        "createTime" => "1349722237676",
+        "semanticState" => {
+          "delivery_attempts" => 1,
+          "state" => {
+            "type" => "DONE"
+          },
+          "version" => "1.0"
+        },
+        "printerid" => "printer_id",
+        "fileUrl" => "https://www.google.com/cloudprint/download?id=job_id",
+        "id" => "job_id",
+        "rasterUrl" => "https://www.google.com/cloudprint/download?id\u003db8fa1266-625b-070c-5968-5039d2fdb982\u0026forcepwg\u003d1",
+        "contentType" => "image/jpeg",
+        "status" => "mocked_status"
+      }
+    }
+  end
 end

data/test/printer_test.rb

@@ -1,4 +1,4 @@
-require "helper"
+require 'helper'
 
 class PrinterTest < Minitest::Test
   def setup
@@ -87,7 +87,6 @@ class PrinterTest < Minitest::Test
     assert_nil job
   end
 
-
   should "print file" do
     fake_connection.expects(:multipart_post).with('/submit', connection_print_file_params).returns(empty_job)
     stub_connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudprint
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Eugen Minciu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -113,6 +113,7 @@ files:
 - Rakefile
 - cloudprint.gemspec
 - lib/cloudprint.rb
+- lib/cloudprint/auth.rb
 - lib/cloudprint/client.rb
 - lib/cloudprint/connection.rb
 - lib/cloudprint/exceptions.rb
@@ -121,6 +122,7 @@ files:
 - lib/cloudprint/printer.rb
 - lib/cloudprint/printer_collection.rb
 - lib/cloudprint/version.rb
+- test/auth_test.rb
 - test/cloudprint_test.rb
 - test/connection_test.rb
 - test/fixtures/ruby.png
@@ -147,11 +149,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: cloudprint
-rubygems_version: 2.4.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: This library provides a Ruby interface to Google Cloud Print.
 test_files:
+- test/auth_test.rb
 - test/cloudprint_test.rb
 - test/connection_test.rb
 - test/fixtures/ruby.png