icanhazpdf 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1186b80b82b56eb8a535e717497bbcd898d8891b
-  data.tar.gz: 70ca09023da1bda53aa73f142816f1bd394607ac
+  metadata.gz: 1e3c30c84c3d9365171cfbac2fa8ce06df2f39ba
+  data.tar.gz: b4203af5b4d792c4e6d9965b4481fdfeebc71450
 SHA512:
-  metadata.gz: b991aff701eb9af0fc7ae3a7bad40157d888dcbfdd2446f595e6ad2cb6212f5e428c444c629b3f72c3d2f3a2a82a19ebadf66af71d8aeb9364ee506a81cfc5cf
-  data.tar.gz: 90d718616f829f512129f22d5f756e513f7f49e857c4f20d6bf94f513c431e615ff6c5c69c405e5abbb69eed8c752b7e9096f1f89ad5f5aad7d574e97c320a8f
+  metadata.gz: a7c0459fce0eb5c775659d2cff2e1f7db3bdde6016b2cb256898aedde7bbb77828a8bb668274d59bf32c4f6628ee8d1b533ee0987c3baf81c2c92f11e93b6583
+  data.tar.gz: 4ddb25a90930ccf0b3dce7368321735ec97f573a646253c30f47d261094e6de538b13610d50fdea30d9f35a5e7d587b4b109b720c6cd310f6f58a79cd99fff3d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    icanhazpdf (0.0.2)
+    Icanhazpdf (0.0.2)
       activesupport (~> 4.0)
       httparty (~> 0.13)
 
@@ -75,9 +75,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  Icanhazpdf!
   bundler (~> 1.6)
   guard-rspec (~> 4.3)
-  icanhazpdf!
   pry (~> 0.10)
   rake (~> 10.3)
   rspec (~> 3.0)

data/README.md

@@ -1,18 +1,18 @@
 # ICanHazPDF?
-Makes using the ICanHazPdf in a Rails app simples
+Makes using the icanhazpdf service in a Rails app simples
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'icanhazpdf', '~> 0.0.2'
+    gem 'icanhazpdf', '~> 0.0.3'
 
 ## Client
 
 To request a pdf is generated (and sent back to you synchronously) use the
 api Client class.
 
-    pdf_response = ICanHazPdf::Client.new.pdf_from_url my_resource_url(resource)
+    pdf_response = Icanhazpdf::Client.new.pdf_from_url my_resource_url(resource)
 
 Your api key is automatically appended to the request.
 The response is the web response from HTTParty. You can then render this or save
@@ -24,7 +24,7 @@ the pdf_response.code to ensure it was successful (should be 200).
 To render a pdf (send the file to the browser) from a url use the renderer module.
 
     class MyController < ApplicationController
-      include ICanHazPdf::Controller::Renderer
+      include Icanhazpdf::Controller::Renderer
 
       def my_action
         render_pdf_from my_resource_url(resource), 'myfilename.pdf'
@@ -38,10 +38,10 @@ filename is used.
 To render a pdf using a previous response from the Client use:
 
     class MyController < ApplicationController
-      include ICanHazPdf::Controller::Renderer
+      include Icanhazpdf::Controller::Renderer
 
       def my_action
-        pdf_response = ICanHazPdf::Client.new.pdf_from_url my_resource_url(resource)
+        pdf_response = Icanhazpdf::Client.new.pdf_from_url my_resource_url(resource)
 
         # do something with the response? save somewhere? upload somewhere?
 
@@ -52,12 +52,10 @@ To render a pdf using a previous response from the Client use:
 ## Authentication
 
 Checks the current request being made is coming from the icanhazpdf service and
-has your configured icanhazapi key in the parameters
-
-    require 'i_can_haz_pdf/controller'
+has your configured Icanhazapi key in the parameters
 
     class Api::ApiController < ActionController::Base
-      include ICanHazPdf::Controller::Authentication
+      include Icanhazpdf::Controller::Authentication
 
       before_filter :authenticate
 
@@ -73,10 +71,9 @@ has your configured icanhazapi key in the parameters
 Checks if the request is either from icanhazpdf or if that fails falls back to
 devise authentication
 
-    require 'i_can_haz_pdf/controller'
 
     class Api::ApiController < ActionController::Base
-      include ICanHazPdf::Controller::Authentication
+      include Icanhazpdf::Controller::Authentication
 
       before_filter :authenticate_as_icanhazpdf_or_authenticate_user!
     end

data/icanhazpdf.gemspec

@@ -1,15 +1,15 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'i_can_haz_pdf/version'
+require 'icanhazpdf/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "icanhazpdf"
-  spec.version       = ICanHazPdf::VERSION
+  spec.version       = Icanhazpdf::VERSION
   spec.authors       = ["Nic Pillinger"]
-  spec.email         = ["nic@thelsf.co.uk"]
-  spec.summary       = 'ICanHazPdf Client'
-  spec.description   = 'Rails gem for generating and serving pdfs using ICanHazPdf service'
+  spec.email         = ["nic@lsf.io"]
+  spec.summary       = 'icanhazpdf'
+  spec.description   = 'Rails gem for generating and serving pdfs using icanhazpdf service'
   spec.homepage      = "http://icanhazpdf.lsfapp.com"
   spec.license       = "MIT"
 

data/lib/icanhazpdf.rb

@@ -0,0 +1,3 @@
+require "icanhazpdf/version"
+require "icanhazpdf/client"
+require "icanhazpdf/controller"

data/lib/{i_can_haz_pdf → icanhazpdf}/client.rb

@@ -1,5 +1,4 @@
-
-module ICanHazPdf
+module Icanhazpdf
 
   # include in order to request generation of pdfs from the icanhazpf service
   # requires that icanhazpdf_api_key is configured in your environment config
@@ -21,12 +20,12 @@ module ICanHazPdf
     # generate a pdf from the url passed
     def pdf_from_url(full_url)
       uri = URI(full_url)
-      params = URI.decode_www_form(uri.query || "") << ['icanhazpdf', ICanHazPdf::Client::api_key]
+      params = URI.decode_www_form(uri.query || "") << ['icanhazpdf', Icanhazpdf::Client::api_key]
       uri.query = URI.encode_www_form(params)
       begin
         service_url = Rails.configuration.icanhazpdf_url
       rescue
-        service_url = ICanHazPdf::Client.default_service_url
+        service_url = Icanhazpdf::Client.default_service_url
       end
       encoded_url = "#{service_url}/#{URI.encode(uri.to_s).gsub(':', '%3A').gsub('/', '%2F').gsub('?', '%3F').gsub('=', '%3D')}"
 

data/lib/{i_can_haz_pdf → icanhazpdf}/controller.rb

@@ -1,7 +1,7 @@
-require 'i_can_haz_pdf/client'
+require 'icanhazpdf/client'
 require 'active_support/core_ext/date_time/conversions'
 
-module ICanHazPdf
+module Icanhazpdf
 
   module Controller
     # include in a controller and use to render pdfs or authenticate requests
@@ -12,7 +12,7 @@ module ICanHazPdf
       def render_pdf_from(url, filename = "")
         options = {}
         options[:filename] = filename if filename.present?
-        render_response_for ICanHazPdf::Client.new.pdf_from_url(url), options
+        render_response_for Icanhazpdf::Client.new.pdf_from_url(url), options
       end
 
       # send the pdf to the user if its a valid file
@@ -28,13 +28,13 @@ module ICanHazPdf
     end
 
     module Authentication
-      # true if the request includes the correct icanhazpdf api key
+      # true if the request includes the correct Icanhazpdf api key
       def authenticate_as_icanhazpdf
         return false unless params[:icanhazpdf].present?
-        return params[:icanhazpdf] == ICanHazPdf::Client::api_key
+        return params[:icanhazpdf] == Icanhazpdf::Client::api_key
       end
 
-      # attemps to authenticate as icanhazpdf and falls back to devise
+      # attemps to authenticate as Icanhazpdf and falls back to devise
       def authenticate_as_icanhazpdf_or_authenticate_user!
         authenticate_as_icanhazpdf || authenticate_user!
       end

data/lib/icanhazpdf/version.rb

@@ -0,0 +1,3 @@
+module Icanhazpdf
+  VERSION = "0.0.3"
+end

data/spec/lib/{i_can_haz_pdf → icanhazpdf}/client_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 require 'httparty'
 
-describe 'ICanHazPdf::Client' do
+describe 'Icanhazpdf::Client' do
 
   let(:a_url) { "http://a.url.to/generate_a_pdf_from?with=querystring" }
-  subject { ICanHazPdf::Client.new }
+  subject { Icanhazpdf::Client.new }
 
   describe 'generating a pdf from' do
     let(:http_response) { double("http_response") }
@@ -42,7 +42,7 @@ describe 'ICanHazPdf::Client' do
         @result = subject.pdf_from_url a_url
       end
 
-      context 'no icanhazpdf api key in the config' do
+      context 'no ocanhazpdf api key in the config' do
         before(:each) do
           allow(rails_config).to receive(:icanhazpdf_api_key).and_raise("Undefined config value")
         end
@@ -58,7 +58,7 @@ describe 'ICanHazPdf::Client' do
         end
 
         it 'uses the default service url' do
-          expect(HTTParty).to receive(:get).with(include(ICanHazPdf::Client.default_service_url), be_an(Hash))
+          expect(HTTParty).to receive(:get).with(include(Icanhazpdf::Client.default_service_url), be_an(Hash))
           @result = subject.pdf_from_url a_url
         end
       end

data/spec/lib/{i_can_haz_pdf → icanhazpdf}/controller_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe "ICanHazPdf::Controller::Renderer" do
+describe "Icanhazpdf::Controller::Renderer" do
 
   class DummyRailsController
-    include ICanHazPdf::Controller::Renderer
+    include Icanhazpdf::Controller::Renderer
   end
 
   let(:url) { 'http://google.com' }
@@ -14,7 +14,7 @@ describe "ICanHazPdf::Controller::Renderer" do
   let(:http_body) { "pdf content" }
 
   before(:each) do
-    allow(ICanHazPdf::Client).to receive(:new).and_return(client)
+    allow(Icanhazpdf::Client).to receive(:new).and_return(client)
     allow(client).to receive(:pdf_from_url).and_return(http_response)
     allow(http_response).to receive(:code).and_return http_status
     allow(http_response).to receive(:body).and_return http_body
@@ -26,7 +26,7 @@ describe "ICanHazPdf::Controller::Renderer" do
   describe 'rendering a pdf from a url' do
 
     it 'creates a client to request the pdf' do
-      expect(ICanHazPdf::Client).to receive(:new)
+      expect(Icanhazpdf::Client).to receive(:new)
       subject.render_pdf_from url, filename
     end
 
@@ -79,10 +79,10 @@ describe "ICanHazPdf::Controller::Renderer" do
 
 end
 
-describe "ICanHazPdf::Controller::Authentication" do
+describe "Icanhazpdf::Controller::Authentication" do
 
   class DummyRailsController
-    include ICanHazPdf::Controller::Authentication
+    include Icanhazpdf::Controller::Authentication
   end
 
   subject { DummyRailsController.new }
@@ -90,7 +90,7 @@ describe "ICanHazPdf::Controller::Authentication" do
   let(:the_api_key) { '34765236754673256735' }
 
   before(:each) do
-    allow(ICanHazPdf::Client).to receive(:api_key).and_return(the_api_key)
+    allow(Icanhazpdf::Client).to receive(:api_key).and_return(the_api_key)
     allow(subject).to receive(:params).and_return(params)
   end
 

data/spec/spec_helper.rb

@@ -1 +1 @@
-require 'i_can_haz_pdf'
+require 'icanhazpdf'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icanhazpdf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nic Pillinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,9 +108,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
-description: Rails gem for generating and serving pdfs using ICanHazPdf service
+description: Rails gem for generating and serving pdfs using icanhazpdf service
 email:
-- nic@thelsf.co.uk
+- nic@lsf.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -123,12 +123,12 @@ files:
 - README.md
 - Rakefile
 - icanhazpdf.gemspec
-- lib/i_can_haz_pdf.rb
-- lib/i_can_haz_pdf/client.rb
-- lib/i_can_haz_pdf/controller.rb
-- lib/i_can_haz_pdf/version.rb
-- spec/lib/i_can_haz_pdf/client_spec.rb
-- spec/lib/i_can_haz_pdf/controller_spec.rb
+- lib/icanhazpdf.rb
+- lib/icanhazpdf/client.rb
+- lib/icanhazpdf/controller.rb
+- lib/icanhazpdf/version.rb
+- spec/lib/icanhazpdf/client_spec.rb
+- spec/lib/icanhazpdf/controller_spec.rb
 - spec/spec_helper.rb
 homepage: http://icanhazpdf.lsfapp.com
 licenses:
@@ -153,8 +153,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: ICanHazPdf Client
+summary: icanhazpdf
 test_files:
-- spec/lib/i_can_haz_pdf/client_spec.rb
-- spec/lib/i_can_haz_pdf/controller_spec.rb
+- spec/lib/icanhazpdf/client_spec.rb
+- spec/lib/icanhazpdf/controller_spec.rb
 - spec/spec_helper.rb

data/lib/i_can_haz_pdf.rb

@@ -1,3 +0,0 @@
-require "i_can_haz_pdf/version"
-require "i_can_haz_pdf/client"
-require "i_can_haz_pdf/controller"

data/lib/i_can_haz_pdf/version.rb

@@ -1,3 +0,0 @@
-module ICanHazPdf
-  VERSION = "0.0.2"
-end