ghoa 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fad4bd0493bd8784480d79ebe06ba877bf66868
+  data.tar.gz: 6b9249806f0d863a91824a1440a8724c89e21165
+SHA512:
+  metadata.gz: 65babfc7b70a25b777cf3abb5786854c5f083d6c149209dca647ab7de8c8d410f36e41b00b43654b3310efdd4fc54a56bd576ab260866c49b9eb3fcde956f2d2
+  data.tar.gz: 3fca15f3a187b0f92d08cc474dfaca3edd0f5887f2857352aae009ce6055120db343713c389a6bf313d7f605186d52c6ddfa0516625dab850f399d3c69192387

data/.gems

@@ -0,0 +1 @@
+cuba -v 3.2.0

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Punchgirls LLC.
+
+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,60 @@
+#Ghoa
+
+A gem for hazzle-free GitHub authentication and retrival of user information.
+
+> ##### Important information!
+> To use this gem you must first register your application on GitHub.
+> For more information on how to register your app and the GitHub 
+> Oauth API have a look here:
+> https://developer.github.com/guides/basics-of-authentication
+
+##Usage
+
+After registering on GitHub you will be provided with a
+*Client ID* and a *Client Secret*. These keys will be used to
+identify your application when communicating with the GitHub API.
+
+To use the ghoa gem you need to require it, and set your API keys, 
+like this:
+
+```ruby
+require "ghoa"
+
+ghoa = Ghoa.new(client_id, client_secret)
+```
+
+Redirect the user to `ghoa.authorize_url` in order for them to 
+authorize your application. 
+
+As soon as the application is authorized the user will be 
+redirected to the call back URL you provided when registering
+the application.
+
+In addition to the redirection, GitHub will add a code to the 
+call back URL. The URL will look something like this:
+`http://localhost:9393/github_oauth?code=71458a8b9256a976f156`
+
+Use this code to fetch an Access Token. You will need the token
+to retrieve the user's GitHub information:
+
+```ruby
+access_token = ghoa.fetch_access_token(code)
+```
+
+To fetch the user do:
+
+```ruby
+user = ghoa.fetch_user(access_token)
+```
+
+For more examples have a look at the test application that can be
+found in `test/app.rb`
+
+##Installation
+
+```
+$ gem install ghoa
+```
+
+
+

data/ghoa.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "ghoa"
+  s.version = "1.0.0"
+  s.summary = "Ruby gem for simple GitHub authentication"
+  s.description = s.summary
+  s.authors = ["Mayn Kjær", "Cecilia Rivero"]
+  s.email = ["mayn.kjaer@gmail.com", "contact@ceciliarivero.com"]
+  s.homepage = "https://github.com/punchgirls/ghoa"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "requests"
+  s.add_development_dependency "cuba"
+end

data/lib/ghoa.rb

@@ -0,0 +1,33 @@
+require "requests"
+
+class Ghoa
+  AUTHORIZE_URL = "https://github.com/login/oauth/authorize?client_id=%s"
+  ACCESS_TOKEN_URL = "https://github.com/login/oauth/access_token"
+  USER_URL = "https://api.github.com/user"
+
+  def initialize(client_id, client_secret)
+    @client_id = client_id
+    @client_secret = client_secret
+  end
+
+  def authorize_url
+    return sprintf(AUTHORIZE_URL, @client_id)
+  end
+
+  def fetch_access_token(code)
+    response = Requests.request("POST", ACCESS_TOKEN_URL,
+      data: { client_id: @client_id,
+              client_secret: @client_secret,
+              code: code },
+      headers: { "Accept" => "application/json" })
+
+    return response.json["access_token"]
+  end
+
+  def fetch_user(access_token)
+    params = { access_token: access_token }
+    response = Requests.request("GET", USER_URL, params: params)
+
+    return response.json
+  end
+end

data/test/app.rb

@@ -0,0 +1,29 @@
+require "cuba"
+require_relative "../lib/ghoa"
+
+CLIENT_ID = ENV.fetch("CLIENT_ID")
+CLIENT_SECRET = ENV.fetch("CLIENT_SECRET")
+
+Cuba.define do
+  ghoa = Ghoa.new(CLIENT_ID, CLIENT_SECRET)
+
+  on "github_oauth" do
+    on param("code") do |code|
+      access_token = ghoa.fetch_access_token(code)
+
+      on access_token != nil do
+        user = ghoa.fetch_user(access_token)
+
+        res.write JSON.dump(user)
+      end
+
+      on default do
+        res.write "An error occured!"
+      end
+    end
+
+    on get, root do
+      res.redirect ghoa.authorize_url
+    end
+  end
+end

data/test/config.ru

@@ -0,0 +1,3 @@
+require "./app"
+
+run(Cuba)

data/test/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+server:
+	env $$(cat .env) shotgun -o 0.0.0.0

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: ghoa
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mayn Kjær
+- Cecilia Rivero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: requests
+  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: cuba
+  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'
+description: Ruby gem for simple GitHub authentication
+email:
+- mayn.kjaer@gmail.com
+- contact@ceciliarivero.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- ".gitignore"
+- LICENSE
+- README.md
+- ghoa.gemspec
+- lib/ghoa.rb
+- test/app.rb
+- test/config.ru
+- test/makefile
+homepage: https://github.com/punchgirls/ghoa
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Ruby gem for simple GitHub authentication
+test_files: []