flickr-login 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg/
+*.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Janko Marohnić
+
+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,145 @@
+# Flickr Login
+
+## About
+
+This gem is a simple Rack endpoint that provides Flickr authentication in your
+web application. You just mount it on your web application and it does the rest of the work.
+
+This gem is an alternative to [omniauth-flickr](https://github.com/timbreitkreutz/omniauth-flickr).
+They both provide similar results, the main difference is that `flickr-login` is much more
+lightweight. If you don't care about that, I would highly suggest that you go with
+`omniauth-flickr`, because `omniauth` is a great standard for authentication.
+
+If you intend to use the user's access token for communication with Flickr's
+API, you'll want to use one of this 2 gems:
+
+- [flickraw](https://github.com/hanklords/flickraw)
+- [flickrie](https://github.com/janko-m/flickrie)
+
+## Installation
+
+Put it into your Gemfile:
+
+```ruby
+gem "flickr-login", require: "flickr/login"
+```
+
+And run `bundle install`.
+
+## Setup
+
+You have to be in possession of your API key and shared secret. If you don't have them yet,
+you can apply for them [here](http://www.flickr.com/services/apps/create/apply).
+In the setup, just replace `API_KEY` and `SHARED_SECRET` with real values.
+
+### Rails
+
+This is an example of how you can the gem in **Rails 3** (in Rails 2 it's probably
+similar).
+
+```ruby
+# config/application.rb
+module YourApp
+  class Application < Rails::Application
+    # ...
+    config.flickr_login = Flickr::Login.new "API_KEY", "SHARED_SECRET"
+    # ...
+  end
+end
+```
+```ruby
+# config/routes.rb
+YourApp::Application.routes.draw do
+  # ...
+  flickr = YourApp::Application.config.flickr_login
+  flickr_endpoint = flickr.login_handler(return_to: "/any-path")
+
+  mount flickr_endpoint => '/login', as: :login
+  # ...
+end
+```
+
+### Sinatra
+
+In Sinatra this is being put in your `config.ru`, which probably looks
+something like this:
+
+```ruby
+# config.ru
+require './app'
+run Sinatra::Application
+```
+
+Now you mount the Rack endpoint like this
+
+```ruby
+# config.ru
+require './app'
+require 'flickr/login'
+
+flickr = Flickr::Login.new "API_KEY", "SHARED_SECRET"
+flickr_endpoint = flickr.login_handler(return_to: "/any-path")
+
+use Rack::Session::Cookie
+run Rack::URLMap.new "/" => Sinatra::Application,
+                     "/login" => flickr_endpoint
+```
+
+That's it. Just enable sessions in your `app.rb`:
+
+```ruby
+# app.rb
+enable :sessions
+```
+
+## What it does
+
+The user will first get redirected to Flickr to approve your application. The
+user is then redirected back to your app (back to the path specified with `:return_to`),
+with `session[:flickr_access_token]` and `session[:flickr_user]` filled in.
+
+- `session[:flickr_access_token]` – an array of access token and access secret
+- `session[:flickr_user]` – a hash of information about the authenticated user
+
+## Configuration
+
+Available options for `Flickr::Login` are:
+
+- `:return_to` – where the user is redirected to after authentication (defaults to `"/"`)
+- `:site` – the API endpoint that is used (defaults to [http://www.flickr.com/services](http://www.flickr.com/services))
+
+You can also set the permissions you're asking from the user. You do this by passing the
+`perms` GET parameter in the URL. For example, going to `http://localhost:9393/login?perms=delete`
+would ask the user for "delete" permissions. You can ask the user for "read", "write" or "delete" permissions.
+
+## Helpers
+
+The `Flickr::Login::Helpers` module adds these methods to your app:
+
+- `#flickr_user` (Hash) – The information about the user who just authenticated
+- `#flickr_access_token` (Array) – The access token and secret
+- `#flickr_clear` – Erases the session that was filled after authentication, effectively logging out the user
+
+In **Rails** you can include the module in your controller:
+
+```ruby
+# app/controllers/session_controller.rb
+class SessionController < ApplicationController
+  include Flickr::Login::Helpers
+end
+```
+
+In **Sinatra** you can just call the `helpers` method:
+
+```ruby
+helpers Flickr::Login::Helpers
+```
+
+## Credits
+
+This gem is almost a direct copy of **@mislav**'s [twitter-login](https://github.com/mislav/twitter-login)
+and [facebook-login](https://github.com/mislav/facebook) gems.
+
+## License
+
+[MIT](https://github.com/janko-m/flickr-login/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/flickr-login.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-8
+Gem::Specification.new do |gem|
+  gem.name          = "flickr-login"
+  gem.authors       = ["Janko Marohnić"]
+  gem.email         = ["janko.marohnic@gmail.com"]
+  gem.description   = %q{This is a Rack endpoint that provides Flickr authentication}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/janko-m/flickr-login"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  gem.add_dependency "oauth"
+end

data/lib/flickr/login.rb

@@ -0,0 +1,88 @@
+require 'oauth'
+require 'uri'
+
+module Flickr
+  class Login
+    DEFAULTS = {
+      site: "http://www.flickr.com/services",
+      return_to: "/"
+    }
+
+    def initialize(api_key, shared_secret, options = {})
+      @api_key, @shared_secret = api_key, shared_secret
+      @options = DEFAULTS.merge(options)
+    end
+
+    def call(env)
+      request = Request.new(env)
+
+      unless request[:oauth_verifier]
+        redirect_to_flickr(request)
+      else
+        handle_flickr_authorization(request)
+      end
+    end
+
+    def login_handler(options = {})
+      @options.update(options)
+      self
+    end
+
+    module Helpers
+      def flickr_user
+        session[:flickr_user]
+      end
+
+      def flickr_access_token
+        session[:flickr_access_token]
+      end
+
+      def flickr_clear
+        [:flickr_user, :flickr_access_token].each do |key|
+          session.delete(key)
+        end
+      end
+    end
+
+    class Request < ::Rack::Request
+      def url_for(path)
+        url = scheme + '://' + host
+        if (scheme == 'https' and port != 443) or (scheme == 'http' and port != 80)
+          url << ":#{port}"
+        end
+        url << path
+      end
+    end
+
+    private
+
+    def redirect_to_flickr(request)
+      callback_url = URI.parse(request.url).tap { |url| url.query = nil }
+      request_token = consumer.get_request_token(oauth_callback: callback_url.to_s)
+      request.session[:flickr_request_token] = [request_token.token, request_token.secret]
+      authorize_params = request[:perms] ? {perms: request[:perms]} : {}
+      redirect request_token.authorize_url(authorize_params)
+    end
+
+    def handle_flickr_authorization(request)
+      request_token = renew_request_token(request)
+      access_token = request_token.get_access_token(oauth_verifier: request[:oauth_verifier])
+      request.session[:flickr_access_token] = [access_token.token, access_token.secret]
+      request.session[:flickr_user] = access_token.params
+      redirect request.url_for(@options[:return_to])
+    end
+
+    def renew_request_token(request)
+      rtoken, rsecret = request.session.delete(:flickr_request_token)
+      OAuth::RequestToken.new(consumer, rtoken, rsecret)
+    end
+
+    def consumer
+      @consumer ||= OAuth::Consumer.new @api_key, @shared_secret, site: @options[:site]
+    end
+
+    def redirect(url)
+      ['302', {'Location' => url, 'Content-type' => 'text/plain'}, []]
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: flickr-login
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a Rack endpoint that provides Flickr authentication
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- flickr-login.gemspec
+- lib/flickr/login.rb
+homepage: https://github.com/janko-m/flickr-login
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []