omniauth-freshbooks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d88fb041e0997960f30403719705bac233608111
+  data.tar.gz: 197055ac42993750af5af03a6b2493b894522001
+SHA512:
+  metadata.gz: aa9c1eed70c222856b6b7be5512d99c285e98463ce35f4bb2e8179b34be9aaeadeb65b912c0316fff631b0f2bb9fd79f87d6f07991fe083a437045adb07628f5
+  data.tar.gz: c89b081c04b7cd4ead79e973f4817f9ce23aad08568b67f8cb5f61407185d37bf344f2c254c02e96d0b37ccd9f56f3d98120924b2018facbce7d440efee97dd1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Francois Deschenes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# OmniAuth FreshBooks
+
+This is the OmniAuth strategy for authentication to [FreshBooks](http://www.freshbooks.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-freshbooks'
+```
+
+And then, you need to add the following to your `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :freshbooks, "consumer_key", "consumer_secret" 
+end
+```
+
+You will obviously have to put in your key and secret, which you get when you [register as a consumer with FreshBooks](http://developers.freshbooks.com/authentication-2/#OAuth).
+
+## Options
+
+The options are:
+
+* **site** The FreshBooks root URI for this site. This can also be passed as a query string parameter although if one specified in your initializer, it will always take precedence. *Example:* `https://sample.freshbooks.com`

data/lib/omniauth/freshbooks.rb

@@ -0,0 +1,6 @@
+require "omniauth/freshbooks/version"
+require "omniauth/strategies/freshbooks"
+
+module Omniauth
+  module Freshbooks; end
+end

data/lib/omniauth/freshbooks/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Freshbooks
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/strategies/freshbooks.rb

@@ -0,0 +1,71 @@
+require "multi_xml"
+require "omniauth-oauth"
+require "oauth/signature/plaintext"
+
+module OmniAuth
+  module Strategies
+    class FreshBooks < OmniAuth::Strategies::OAuth
+      option :client_options, {
+        access_token_path: "/oauth/oauth_access.php",
+        authorize_path: "/oauth/oauth_authorize.php",
+        request_token_path: "/oauth/oauth_request.php",
+        signature_method: "PLAINTEXT"
+      }
+      
+      uid { options.client_options.site + "/" + raw_info["staff_id"] }
+      
+      info do
+        {
+          name: [raw_info["first_name"], raw_info["last_name"]].compact.join(" "),
+          first_name: raw_info["first_name"],
+          last_name: raw_info["last_name"],
+          email: raw_info["email"],
+          nickname: raw_info["username"],
+          location: [raw_info["city"], raw_info["state"], raw_info["country"]].compact.join(", "),
+          phone: raw_info["business_phone"],
+          urls: {
+            "FreshBooks" => options.client_options.site
+          }
+        }
+      end
+      
+      extra do
+        { raw_info: raw_info }
+      end
+      
+      def redirect(*args)
+        session["oauth"][name.to_s].merge!({
+          "site" => options.client_options.site
+        })
+        super
+      end
+      
+      def request_phase
+        options.client_options.site = options.site.presence || session["omniauth.params"]["site"].presence
+        
+        unless options.client_options.site
+          OmniAuth::Form.build(title: (options.title.presence || "FreshBooks Authentication")) do |form|
+            form.text_field "URL", "site"
+          end.to_response
+        else
+          super
+        end
+      rescue URI::InvalidURIError
+        return fail!(:invalid_site)
+      rescue Net::HTTPRetriableError
+        return fail!(:invalid_site)
+      end
+      
+      def callback_phase
+        options.client_options.site = session["oauth"][name.to_s]["site"] if session["oauth"].present?
+        super
+      end
+      
+      def raw_info
+        @raw_info ||= MultiXml.parse(access_token.post("/api/2.1/xml-in", '<?xml version="1.0" encoding="utf-8"?><request method="staff.current"></request>').body).fetch("response").fetch("staff")
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization "freshbooks", "FreshBooks"

data/spec/omniauth/strategies/freshbooks_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+require "omniauth/freshbooks"
+
+describe OmniAuth::Strategies::FreshBooks do
+  subject do
+    OmniAuth::Strategies::FreshBooks.new(nil, @options || {})
+  end
+  
+  describe "#client" do
+    it "has correct access token path" do
+      subject.options.client_options["access_token_path"].should eq("/oauth/oauth_access.php")
+    end
+    
+    it "has correct authorize path" do
+      subject.options.client_options["authorize_path"].should eq("/oauth/oauth_authorize.php")
+    end
+
+    it "has correct request token path" do
+      subject.options.client_options["request_token_path"].should eq("/oauth/oauth_request.php")
+    end
+    
+    it "has correct signature method" do
+      subject.options.client_options["signature_method"].should eq("PLAINTEXT")
+    end
+  end
+  
+  describe "#info" do
+    before :each do
+      @raw_info = {
+        "staff_id" => "1",
+        "username" => "jsmith",
+        "first_name" => "John",
+        "last_name" => "Smith",
+        "email" => "jsmith@example.org",
+        "business_phone" => "(123) 456-7890",
+        "mobile_phone" => "",
+        "rate" => "0",
+        "last_login" => "2008-11-20 13:26:00",
+        "number_of_logins" => "13",
+        "signup_date" => "2008-10-22 13:57:00",
+        "street1" => "123 ABC Street",
+        "street2" => "",
+        "city" => "Toronto",
+        "state" => "Ontario",
+        "country" => "Canada",
+        "code" => "M1M 1A1"
+      }
+      
+      subject.stub(:raw_info) { @raw_info }
+    end
+    
+    context "when data is present in raw info" do
+      it "returns the combined name" do
+        subject.info[:name].should eq("John Smith")
+      end
+      
+      it "returns the first name" do
+        subject.info[:first_name].should eq("John")
+      end
+      
+      it "returns the last name" do
+        subject.info[:last_name].should eq("Smith")
+      end
+      
+      it "returns the email" do
+        subject.info[:email].should eq("jsmith@example.org")
+      end
+      
+      it "returns the nickname" do
+        subject.info[:nickname].should eq("jsmith")
+      end
+      
+      it "returns the user location" do
+        subject.info[:location].should eq("Toronto, Ontario, Canada")
+      end
+      
+      it "returns the phone" do
+        subject.info[:phone].should eq("(123) 456-7890")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path("..", __FILE__)
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "bundler/setup"
+require "rspec"
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-freshbooks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Francois Deschenes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FreshBooks OAuth strategy for OmniAuth
+email:
+- fdeschenes@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/omniauth/freshbooks/version.rb
+- lib/omniauth/freshbooks.rb
+- lib/omniauth/strategies/freshbooks.rb
+- spec/omniauth/strategies/freshbooks_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fdeschenes/omniauth-freshbooks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: FreshBooks OAuth strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/freshbooks_spec.rb
+- spec/spec_helper.rb