auth_tool 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d56792e99a023ce052116b150b3bc522ffc6056
-  data.tar.gz: c4f27a14ea74ddcc4399315c8f04958df1338991
+  metadata.gz: 70920dcd4afbb68a32b3195629f9fb62a042326f
+  data.tar.gz: 3be6cf4fd1567d7452a48a674a1ee336cf7ec550
 SHA512:
-  metadata.gz: 1e3de273379e2ac32cfece719ea7d047337391258fec315fd489b8ac437dfa7c83598d557575ff5062b1281a635f0c80079b974133abcac5b00a8c188be5d19c
-  data.tar.gz: 37b3e51fc31bda161153a959bc5b5df44bf496f2a54ccfe216a71e30fc322dc95b87e8171e47b38feeb32b071cda517c7e46a02a17a626d05ee56cdd8357f06f
+  metadata.gz: ed388c1d6a97eacfa9fd7fa6b39d990892ad0efd56a71f7b4670e7cad80608dc8a5e9040350ee52fd098b737e6e30bf78abd48cf01cc4685daabdd28a8eaf7f4
+  data.tar.gz: 4c76d3c359f7d537751d4e7b24f359fc440c2f8e97621ad6ad2c06cbc884353a510d86405685023e2c6c30573f121021d869e0cf90191dc629c8f0a9d9aeeac9

data/examples/oauth1-twitter.rb

@@ -1,6 +1,8 @@
 require 'sinatra'
-require_relative '../auth_tool'
-  client = AuthTool::get_client 'twitter'
+require_relative '../lib/auth_tool'
+  #client = AuthTool::get_client 'twitter'
+  client = AuthTool::get_client({"temporary_credential_uri" => "https://api.twitter.com/oauth/request_token", "authorization_uri" => "https://api.twitter.com/oauth/authorize", "token_credential_uri" => "https://api.twitter.com/oauth/access_token", "client_credential_key" => "ajkMgzvyhFwZV9hBgQjlW0rrG", "client_credential_secret" => "BKorJt4MRMpGxCGXNWGz0nFBhd7XfRx3vOHQpL24LKImcLlKXU", "callback" => "http://localhost:4567/callback", "verifier" => "oauth_verifier", "oauth_version" => "1" })
+
 get '/' do
   redirect AuthTool::get_redirect_url client
 end

data/examples/oauth2-github.rb

@@ -1,6 +1,7 @@
 require 'sinatra'
-require_relative '../auth_tool'
-  client = AuthTool::get_client 'github'
+require_relative '../lib/auth_tool'
+  #client = AuthTool::get_client 'github'
+  client = AuthTool::get_client JSON.parse({ "client_id":"c1d4265302eba1aa4f37", "authorization_uri":"https://github.com/login/oauth/authorize", "token_credential_uri":"https://github.com/login/oauth/access_token", "client_secret":"7be3891166bdfc95193b20bf3e65dbf0844e2121", "oauth_version": "2", "redirect_uri": "http://localhost:4567/callback", "scope": "user" })
 get '/' do
   redirect AuthTool::get_redirect_url client
 end

data/lib/auth_tool/client.rb

@@ -9,8 +9,11 @@ module AuthTool
     #
     # @param [Hash] options
     #   Configuration parameters for the client.
-    def initialize(options, *credentials)
+    def initialize(options, *args)
       config = options
+      credentials = args[0] if args.length == 1
+      credentials ||= {}
+      raise "Too many args" if args.length > 1
       @has_params = config.has_key?('params')
       self.oauth_version = config.delete('oauth_version')
       self.params = config.delete('params') if @has_params
@@ -21,7 +24,7 @@ module AuthTool
       elsif @oauth_version == 2
         oauth2 config
         self.signet.access_token = credentials["oauth_token"] if credentials.has_key? "oauth_token"
-        self.signet.refresh_token = credentials["refresh_token"] if credentialsl.has_key? "refresh_token" 
+        self.signet.refresh_token = credentials["refresh_token"] if credentialsl.has_key? "refresh_token"
       else
         raise "Unexpected oauth_version: #{@oauth_version}"
       end

data/lib/auth_tool/oauth_1.rb

@@ -1,5 +1,6 @@
 require_relative 'client'
 require 'json'
+require 'faraday'
 
 module AuthTool
   module OAuth1
@@ -61,7 +62,7 @@ module AuthTool
     def self.call(client, http_verb = 'get', uri, params)
       header = params.delete('header') if params.has_key? 'header'
       body = params.delete('body') if params.has_key? 'body'
-      conn = AuthTool::Helper.get_connection(params)
+      conn = Faraday.new(:params => params)
       options = {:method => http_verb, :header => header, :body => body, :uri => uri, :connection => conn}
       response = client.signet.fetch_protected_resource(options)
       return JSON.parse(response.body)

data/lib/auth_tool/oauth_2.rb

@@ -1,3 +1,4 @@
+require 'faraday'
 require_relative 'client'
 
 module AuthTool
@@ -50,7 +51,7 @@ module AuthTool
     def self.call(client,http_verb = 'get', uri, params)
       header = params.delete('header') if params.has_key? 'header'
       body = params.delete('body') if params.has_key? 'body'
-      conn = AuthTool::Helper.get_connection(params)
+      conn = Faraday.new(:params => params)
       options = {:method => http_verb, :header => header, :body => body, :uri => uri, :connection => conn}
       response = client.signet.fetch_protected_resource(options)
       return JSON.parse(response.body)

data/lib/auth_tool/version.rb

@@ -1,3 +1,3 @@
 module AuthTool
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
 end

data/lib/auth_tool.rb

@@ -1,5 +1,4 @@
 require_relative 'auth_tool/client'
-require_relative 'auth_tool/helper'
 require_relative 'auth_tool/oauth_1'
 require_relative 'auth_tool/oauth_2'
 
@@ -7,12 +6,13 @@ module AuthTool
   ##
   # Creates a client object for the specified API.
   #
-  # @param [String] api_name
-  #   The name of the API/company.
+  # @param [String] client_secrets
+  #   The client_secrets hash for the API
   #
   # @return [AuthTool::Client] The client.
-  def self.get_client api_name
-    client = create_client(read_config(api_name))
+  def self.get_client client_secrets
+    raise "Expected Hash, received #{client_secrets.class}" if client_secrets.class != Hash
+    client = create_client(client_secrets)
     return client
   end
 
@@ -98,13 +98,4 @@ module AuthTool
   def self.create_client options
     AuthTool::Client.new options
   end
-
-  ##
-  # Gets config hash for the given API
-  #
-  # @param [String] api_name
-  #   The name of the API/Company as it appears in the database
-  def self.read_config api_name
-    AuthTool::Helper.read_secrets(api_name)
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auth_tool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - David Fan
@@ -54,13 +54,10 @@ files:
 - auth_tool.gemspec
 - bin/console
 - bin/setup
-- client_secrets/README.md
-- client_secrets/client_secrets.json
 - examples/oauth1-twitter.rb
 - examples/oauth2-github.rb
 - lib/auth_tool.rb
 - lib/auth_tool/client.rb
-- lib/auth_tool/helper.rb
 - lib/auth_tool/oauth_1.rb
 - lib/auth_tool/oauth_2.rb
 - lib/auth_tool/version.rb

data/client_secrets/README.md

@@ -1,33 +0,0 @@
-client_secrets.json
-===
-
-Format for basic 3-legged OAuth entries:
----
-```
-{
-  "api_name":{
-    "temporary_credential_uri": "oauth/request_token",
-    "authorization_uri": "oauth/authorize",
-    "token_credential_uri": "oauth/access_token",
-    "client_credential_key": "key",
-    "client_credential_secret": "secret",
-    "callback": "callback",
-    "verifier": "verifier",
-    "oauth_version": "version",
-    "params:"{
-      "sample_param": "sample"
-    }
-  }
-```
-Parameters:
----
-- **api_name**: Lowercase name of the API/company.
-- **temporary_credential_uri**: Full URL of the request token endpoint.
-- **authorization_uri**: URL to redirect the user to so they can authenticate with the service.
-- **token_credential_uri**: Full URL of the access token endpoint.
-- **client_credential_key**: Client key (ID) provided by the service's API dashboard.
-- **client_credential_secret**: Client secret provided by the service's API dashboard.
-- **callback**: Securable callback URL (**TODO:** update once we figure out the endpoint).
-- **verifier**: Name of the verifier key that the Auth server passes back after the user successfully authenticates with them.
-- **oauth_version**: Either 1 or 2 depending on the OAuth implementation of the API.
-- **params**: (Optional) Hash of extra parameter values that the API requests.

data/client_secrets/client_secrets.json

@@ -1,41 +0,0 @@
-{
-  "twitter":{
-    "temporary_credential_uri": "https://api.twitter.com/oauth/request_token",
-    "authorization_uri": "https://api.twitter.com/oauth/authorize",
-    "token_credential_uri": "https://api.twitter.com/oauth/access_token",
-    "client_credential_key": "ajkMgzvyhFwZV9hBgQjlW0rrG",
-    "client_credential_secret": "BKorJt4MRMpGxCGXNWGz0nFBhd7XfRx3vOHQpL24LKImcLlKXU",
-    "callback": "http://localhost:4567/callback",
-    "verifier": "oauth_verifier",
-    "oauth_version": "1"
-  },
-  "cacoo":{
-    "temporary_credential_uri": "https://cacoo.com/oauth/request_token",
-    "authorization_uri": "https://cacoo.com/oauth/authorize",
-    "token_credential_uri": "https://cacoo.com/oauth/access_token",
-    "client_credential_key": "GSObuYmNbvzIRWlDRiHLyI",
-    "client_credential_secret": "pHCMknNDivnkAeSreVpKZZhNdAasUGGimBmBagSDlj",
-    "callback": "http://localhost:4567/",
-    "verifier": "oauth_verifier",
-    "oauth_version": "1"
-  },
-  "google":{
-    "client_id":"915626980700-ks501tpkrffod16sjvbumikt1q3s5q5m.apps.googleusercontent.com",
-    "project_id":"atomic-optics-168719",
-    "authorization_uri":"https://accounts.google.com/o/oauth2/auth",
-    "token_credential_uri":"https://accounts.google.com/o/oauth2/token",
-    "auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs",
-    "client_secret":"N7ceZl5u0mGZ8E-v-2hNj6Iz",
-    "oauth_version": "2",
-    "redirect_uri": "http://localhost:4567/",
-    "scope":"https://www.googleapis.com/auth/adsensehost"},
-  "github":{
-    "client_id":"c1d4265302eba1aa4f37",
-    "authorization_uri":"https://github.com/login/oauth/authorize",
-    "token_credential_uri":"https://github.com/login/oauth/access_token",
-    "client_secret":"7be3891166bdfc95193b20bf3e65dbf0844e2121",
-    "oauth_version": "2",
-    "redirect_uri": "http://localhost:4567/callback",
-    "scope": "user"
-  }
-}

data/lib/auth_tool/helper.rb

@@ -1,33 +0,0 @@
-require 'json'
-require 'faraday'
-
-f = File.new('../client_secrets/client_secrets.json', 'r')
-Client_secrets = JSON.parse(f.read).freeze
-
-module AuthTool
-  module Helper
-    ##
-    # Returns the configuration hash for the given API.
-    #
-    # @param [String] api_name
-    #   The api you wish to authenticate against (i.e., twitter)
-    #
-    # @return [Hash] The configuration hash for api_name
-    def self.read_secrets api_name
-      raise "API not found" unless Client_secrets.has_key?(api_name.downcase)
-      return Client_secrets[api_name.downcase]
-    end
-
-    ##
-    # Returns a Faraday Connetion object
-    #
-    # @param [Hash] params
-    #   The additional parameters hash.
-    #
-    # @return [Faraday::Connection]
-    def self.get_connection(params)
-      connection = Faraday.new(:params => params)
-      return connection
-    end
-  end
-end