cloudprint 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmNiYTc0NGUzMGVmMTI1ZDAxYmNlMjE1NjhmNDg2OWY2MWU5ZWJjNw==
+  data.tar.gz: !binary |-
+    NmY2YmVjM2JlOGMwNTA4Y2YxNTM5ZTY2Y2U2ZGVkZjIyYWE2MmE1Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWM3YjZjN2E3YjQ5MzZjNzM3ZTMwZTYwNzkxYzEyODRiN2QxZjYxYWVkYmY4
+    NjUxMGQ2MzYxMGY0NTQyYzlmYWIxMTUxMmU0YzYwZDQwYWZjOGY4NmIyMDBm
+    OWJiYTU1YWM0YTI4NmMwYTczMDg5ZDk1MGUyZjAyM2ExNWFjYTE=
+  data.tar.gz: !binary |-
+    YjJjMmFmMDVlN2U1OTRkNWRmN2E3ODIwZTA0ZTY3NWVhYmFjNGQxOGVjMjY4
+    MjBmZTc1NTk4ZDQ2Yzg0MjE4ZTU2NGJmMmM5ZWZiOTAwMGIwZDFhZGVhMTNh
+    ZDg1MGM2ODczZDUyZGQxYjQ0YTZlMTNjNDU1NDZjYzI5ZmY3Nzg=

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 .bundle
+Gemfile.lock
 pkg/*
 tags

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/README.md

@@ -0,0 +1,121 @@
+## Cloudprint [![Build Status](https://travis-ci.org/minciue/cloudprint.png?branch=master)](https://travis-ci.org/minciue/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.
+
+### 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.
+
+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.  
+
+### 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.
+
+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)
+
+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.
+
+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)
+
+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.
+
+### 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.
+
+```ruby
+client = CloudPrint::Client.new(
+  refresh_token: 'refresh_token',
+  client_id: 'client_id',
+  client_secret: 'client_secret',
+  callback_url: 'callback_url'
+)
+```
+
+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.
+printers = client.printers.all                      
+
+# Get a printer with a specific id
+my_printer = client.printers.find('printer_id')
+
+# Print using this printer.
+# The :content option can also take a File object as a parameter. 
+# CloudPrint accepts HTML and PDF files.
+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.
+
+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.
+
+```ruby
+my_job = client.print_jobs.find('job_id')
+
+# Returns the status, one of QUEUED, IN_PROGRESS, DONE, ERROR, SUBMITTED
+my_job.status 
+```
+
+You can also delete a job, after it has finished.
+
+```ruby
+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:
+
+```ruby
+my_printer = CloudPrint::Printer.new(id: 'id', status: 'OK', name: 'test_printer', display_name: 'Test Printer'
+my_job = CloudPrint::PrintJob.new({}) # see the PrintJob class for what this hash can hold
+my_printer.stubs(:print).returns(my_job)
+```
+
+### More help
+Please submit an issue via GitHub if you need more help with the cloudprint gem.

data/Rakefile

@@ -5,4 +5,6 @@ Rake::TestTask.new(:test) do |test|
 	test.libs << 'lib' << 'test'
 	test.pattern = 'test/*_test.rb'
 	test.verbose = true
-end
+end
+
+task :default => [:test]

data/cloudprint.gemspec

@@ -15,10 +15,10 @@ This library provides a ruby-esque interface to Google Cloud Print.
 cloudprint is a work in progress. I'll be adding documentation once all the basic GCP functionality is supported."
 DESC
 
-  s.add_dependency 'oauth2', '~> 0.5.2'
+  s.add_dependency 'oauth2', '~> 0.8.0'
   s.add_dependency 'json'
 
-  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'mocha', '~> 0.10.0'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'shoulda-context'
   s.add_development_dependency 'test-unit'

data/lib/cloudprint.rb

@@ -4,77 +4,10 @@ require "oauth2"
 require "json"
 
 require "cloudprint/version"
+require "cloudprint/client"
+require "cloudprint/printer_collection"
 require "cloudprint/printer"
 require "cloudprint/connection"
+require "cloudprint/print_job_collection"
 require "cloudprint/print_job"
-
-
-module CloudPrint
-  def self.setup(options = {})
-    @refresh_token = options[:refresh_token]
-    @client_id = options[:client_id]
-    @client_secret = options[:client_secret]
-    @callback_url = options[:callback_url]
-  end
-
-  def self.client_secret
-    @client_secret
-  end
-
-  def self.client_id
-    @client_id
-  end
-
-  def self.refresh_token
-    @refresh_token
-  end
-
-  def self.callback_url
-    @callback_url
-  end
-
-  def self.connection
-    @connection ||= Connection.new
-  end
-
-
-  def self.access_token
-    if access_token_valid?
-      get_existing_access_token.token
-    else
-      get_new_access_token.token
-    end
-  end
-
-  def self.refresh_token=(new_token)
-    @refresh_token = new_token
-    get_new_access_token
-  end
-
-  private
-
-  def self.access_token_valid?
-    get_existing_access_token != nil && get_existing_access_token.token && get_existing_access_token.token.strip != "" && !get_existing_access_token.expired?
-  end
-
-  def self.get_existing_access_token
-    @oauth2_access_token
-  end
-
-  def self.get_new_access_token
-    @oauth2_access_token = new_oauth2_access_token
-    @oauth2_access_token
-  end
-
-  def self.oauth_client
-    @oauth_client ||= OAuth2::Client.new(CloudPrint.client_id, CloudPrint.client_secret,
-                       :authorize_url => "/o/oauth2/auth",
-                       :token_url => "/o/oauth2/token",
-                       :access_token_url => "/o/oauth2/token",
-                       :site => 'https://accounts.google.com/')
-  end
-
-  def self.new_oauth2_access_token
-    OAuth2::AccessToken.new(oauth_client, "", :refresh_token => CloudPrint.refresh_token).refresh!
-  end
-end
+require "cloudprint/exceptions"

data/lib/cloudprint/client.rb

@@ -0,0 +1,48 @@
+module CloudPrint
+  class Client
+    attr_reader :client_secret
+    attr_reader :client_id
+    attr_reader :refresh_token
+    attr_reader :callback_url
+    attr_reader :connection
+    attr_reader :printers
+    attr_reader :print_jobs
+    
+    def initialize(options = {})
+      @refresh_token = options[:refresh_token]
+      @client_id = options[:client_id]
+      @client_secret = options[:client_secret]
+      @callback_url = options[:callback_url]
+      @connection = Connection.new(self)
+      @printers = PrinterCollection.new(self)
+      @print_jobs = PrintJobCollection.new(self)
+    end
+    
+    def access_token
+      (access_token_valid? && @access_token || renew_access_token!).token
+    end
+
+    def refresh_token=(new_token)
+      @refresh_token = new_token
+      renew_access_token!
+    end
+
+    def access_token_valid?
+      @access_token.is_a?(OAuth2::AccessToken) && !@access_token.token.to_s.strip.empty? && !@access_token.expired?
+    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/connection.rb

@@ -2,9 +2,13 @@ require 'ostruct'
 require "net/https"
 require "uri"
 
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 module CloudPrint
   class Connection
+
+    def initialize client
+      @client = client
+    end
+    
     def get(path, params = {})
       response = request(:get, path, params)
       parse_response(response)
@@ -68,7 +72,7 @@ module CloudPrint
     end
 
     def set_request_headers(request)
-      request['Authorization'] = "OAuth " + CloudPrint.access_token
+      request['Authorization'] = "OAuth " + @client.access_token
       request['X-CloudPrint-Proxy'] = 'api-prober'
     end
 
@@ -92,4 +96,4 @@ module CloudPrint
       "https://www.google.com/cloudprint" + path
     end
   end
-end
+end

data/lib/cloudprint/exceptions.rb

@@ -0,0 +1,6 @@
+module CloudPrint
+
+	class RequestError < StandardError
+	end
+
+end

data/lib/cloudprint/print_job.rb

@@ -1,51 +1,57 @@
 module CloudPrint
   class PrintJob
-    attr_reader :id, :status, :error_code
-    def initialize(options = {})
-      @id = options[:id]
-      @status = options[:status]
-      @error_code = options[:error_code]
-    end
+    STATUSES = %w{QUEUED IN_PROGRESS DONE ERROR SUBMITTED}
 
-    def self.find(jobid)
-      job = find_by_id(jobid)
-      return nil if job.nil?
-      self.new(:id => job['id'], :status => job['status'], :error_code => job['errorCode'])
-    end
+    attr_reader :client
 
-    def refresh!
-      job = self.class.find_by_id(id)
-      @status = job['status']
-      @error_code = job['errorCode']
-      self
+    class << self
+      def new_from_response client, response_hash
+        new client, Util.normalize_response_data(response_hash)
+      end
     end
 
-    def queued?
-      status == "QUEUED"
+    def initialize(client, data)
+      @client = client
+      @data = data
     end
 
-    def in_progress?
-      status == "IN_PROGRESS"
-    end
-
-    def done?
-      status == "DONE"
-    end
-
-    def error?
-      status == "ERROR"
-    end
-
-    def submitted?
-      status == "SUBMITTED"
+    def refresh!
+      @data = Util.normalize_response_data(client.print_jobs.find_by_id(id))
+      self
     end
 
-  private
-
-    def self.find_by_id(id)
-      response = CloudPrint.connection.get('/jobs') || {}
-      return nil unless response['jobs'].is_a?(Array)
-      response['jobs'].select{ |job| job['id'] == id }.first
+    def delete!
+      response = client.connection.get('/deletejob', { :jobid => id })
+      response['success'] || raise(RequestError, response['message'])
+    end
+
+    def method_missing(meth, *args, &block)
+      if @data.has_key?(meth)
+        @data[meth]
+      elsif STATUSES.map{ |s| s.downcase + '?' }.include?(meth.to_s)
+        @data[:status].downcase == meth.to_s.chop
+      else
+        super
+      end
+    end
+
+    module Util
+      def self.normalize_response_data(response_hash)
+        {
+          :id => response_hash['id'],
+          :status => response_hash['status'],
+          :error_code => response_hash['errorCode'],
+          :printer_id => response_hash['printerid'],
+          :title => response_hash['title'],
+          :content_type => response_hash['contentType'],
+          :file_url => response_hash['fileUrl'],
+          :ticket_url => response_hash['ticketUrl'],
+          :create_time => Time.at(response_hash['createTime'].to_f / 1000),
+          :update_time => Time.at(response_hash['updateTime'].to_f / 1000),
+          :message => response_hash['message'],
+          :tags => response_hash['tags']
+        }
+      end
     end
   end
 end

data/lib/cloudprint/print_job_collection.rb

@@ -0,0 +1,39 @@
+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?
+      new_from_response job
+    end
+
+    def all
+      fetch_jobs.map { |j| new_from_response j }
+    end
+
+    def new data
+      PrintJob.new client, data
+    end
+
+    def new_from_response response
+      PrintJob.new_from_response client, response
+    end
+
+    private
+
+    def find_by_id(id)
+      fetch_jobs.select{ |job| job['id'] == id }.first
+    end
+
+    def fetch_jobs
+      response = client.connection.get('/jobs') || {}
+      response['jobs'] || []
+    end
+  end
+end