dailycred 0.1.8 → 0.1.21

data/.gitignore

@@ -15,7 +15,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-localtest/
-twooter/
-examples/tester/
-examples/

data/Gemfile

@@ -1,18 +1,6 @@
 source 'https://rubygems.org'
 
+# Specify your gem's dependencies in omniauth-dailycred.gemspec
 gemspec
-gem 'rspec'
-gem 'rails', '~> 3.2.12'
-gem 'simplecov'
-gem 'ruby_gntp'
-gem 'growl'
-gem 'spork'
-gem 'guard'
-gem 'guard-test'
-gem 'guard-rspec'
-gem "mocha", '0.12.1', :require => false
-gem 'fl-rocco'
-gem 'redcarpet', '~> 1.17'
-gem 'markdown'
-gem 'maruku'
-gem 'faraday'
+
+gem 'omniauth'

data/README.md

@@ -1,223 +1,67 @@
-## Ruby on Rails
+# Dailycred
 
-The Dailycred ruby gem is everything you need to get off the ground running with robust authentication. It includes an [omniauth](https://github.com/intridea/omniauth) provider and a generator to create necessary models and controllers. The generated authentication structure is inspired by [nifty-generators](https://github.com/ryanb/nifty-generators). 
+## Installation
 
-If you'd rather only communicate with Dailycred through OAuth and provide your own authentication controllers and models, you can use the [omniauth_dailycred](https://github.com/dailycred/omniauth_dailycred) gem.
+Add this line to your application's Gemfile: 
 
-##Installation
+And then execute:
 
-To get started using Dailycred with Ruby on Rails, the first thing you need to do is add the dailycred gem to your gemfile:
+    $ bundle
 
-    gem 'dailycred'
+Or install it yourself as:
 
-Make sure you've signed up for Dailycred, and head over to your [settings](https://www.dailycred.com/admin/settings) page to get your API keys. Once you've done that, head back to the command line and run:
+    $ gem install omniauth-dailycred
 
-    bundle
-    rails g dailycred
-    rake db:migrate
-
-Thats it! You've successfully added authentication to your app, and you can start signing up users. Run `rails s` to start your
-    server, and point your browser to [http://localhost:3000/auth](http://localhost:3000/auth) and you'll see a pre-built page with links to sign up.
-
-Here's what the dailycred gem generates for you:
-
-*   A few helper methods to `/app/controllers/application_controller.rb`.
-*   An initializer file at `/config/initializers/omniauth.rb` which configures your dailycred API keys.
-*   `/app/models/user.rb`, the User model.
-*   A migration file to create the user table in your database.
-
-
-While this is enough to get off the ground running with user authentication, this setup is meant to be lightweight and flexible, so feel free to tinker with
-    any of the generated code to better match your needs.
-
-## Authenticating
+## Usage
 
-### login_path
-
-A helper for linking to the authentication url.
-
-    <%= link_to 'sign up', login_path %>
-    # => <a href="/auth/dailycred">sign up</a>
-
-### logout_path
-
-To logout a user, simply send them to `/auth/logout`.
-
-    <%= link_to 'logout', logout_path %>
-    # => <a href="/auth/logout">logout</a>
+bash
     
-### authenticate
-
-To protect a controller method from unauthorized users, use the 'authorize' helper method as a `before_filter`.
-
-    #before_filter :authenticate, :except => [:index] #don't authenticate some
-    #before_filter :authenticate, :only => [:create, :new] #only authenticate some
-    before_filter :authenticate #all methods
-
-## Social Connect
-
-To use a social sign-in service instead of email, and password, use `connect_path.`
-
-    <%= link_to 'sign in with facebook', connect_path(:identity_provider => :facebook) %>
-
-The `identity_provider` can be one of `facebook`, `google`, `twitter`, `disqus`, or `instagram`.
-
-After a user has social connected, their social data is serialized into individual fields in the user model. The serialized object is the exact same as what the social provider's graph response returns. For example:
-
-    p current_user.facebook
-    # =>
-    {
-        "video_upload_limits" => {
-            "length" => 1200.0,
-            "size" => 1073741824.0
-        },
-        "locale" => "en_US",
-        "link" => "http://www.facebook.com/joe.smith",
-        "updated_time" => "2012-09-27T19:04:38+0000",
-        "currency" => {
-            "user_currency" => "USD",
-            "currency_exchange" => 10.0,
-            "currency_exchange_inverse" => 0.1,
-            "currency_offset" => 100.0
-        },
-        "picture" => {
-            "data" => {
-                "url" => "http://profile.ak.fbcdn.net/hprofile-ak-ash4/370570_1039690812_2022945351_q.jpg",
-                "is_silhouette" => false
-            }
-        },
-        "id" => "1092609812",
-        "third_party_id" => "cBLDKnqlfYlReV7Jo4yRAFB1a4I",
-        "first_name" => "Joe",
-        "username" => "jsmitty",
-        "bio" => "shred the gnar.",
-        "email" => "jsmitty@dailycred.com",
-        "verified" => true,
-        "name" => "Joe Smith",
-        "last_name" => "Stoever",
-        "gender" => "male",
-        "access_token" =>"AAAFHsZAi9ddUBAKPMOKPDrmJlclwCoVHCfwflF5ZCyLZC70SOo0MPvj62lhHZAnV6jk8DEfBSjLtfcyC7Bx25a9CLphzoayv3EtvbE2tAQZDZD"
-    }
+    rails g dailycred YOUR_CLIENT_ID YOUR_SECRET_KEY
+    rake db:migrate
 
-You can also connect additional social accounts to an existing user:
+This will generate everything you need to get going with authentication, including a user model, session controller, omniauth initializer, javascript tracking code, and many helper variables. You will You can locate your API keys at [dailycred](https://www.dailycred.com/admin/settings/keys)
 
-    <%= link_to 'connect with facebook', connect_user(:facebook) %>
+##### Authentication
 
-`connect_user` defaults to connecting the `current_user`, but you can explicitly connect any user:
+Use the `:authenticate` helper to require a user to be signed in:
 
-    <%= link_to 'connect with google', connect_user(:google, @user) %>
+    before_filter :authenticate
 
----
+The current user object can be located with `current_user`:
 
-##Helpers
+    # in posts_controller
 
-There are a few other helper methods available:
+    @posts = currrent_user.posts.all
 
-### current_user
+##### Using only with Omniauth
 
-Returns the current logged in user or nil. Example usage:
+If you already have omniauth set up and only want to use Dailycred as another OAuth provider, just add this line to your omniauth initializer file
 
-    if !current_user.nil?
-      redirect_to :controller => 'welcome', :action => 'thanks'
-    end
+    provider :dailycred, 'CLIENT_ID', 'SECRET_KEY'
 
-### dailycred
+##### Events
 
-A helper for instantiating a dailycred client instance. Use as a `before_filter` to load a @dailycred instance variable, or just use it as a helper method. Example usage:
+To fire an event to be logged in Dailycred:
 
-As a before filter:
+    #in your controller
 
     before_filter :dailycred
 
-    def index
-        @dailycred.event(current_user.uid, "New Task", @task.name)
-    end
+    def create
+      ...
 
-or just as a helper
+      # after successfully saving the model:
+      @dailycred.event(current_user.uid, 'Created Post', @post.name)
 
-    def index
-        dailycred.event(current_user.uid, "New Task", @task.name)
     end
 
-### Tagging a User
-
-Dailycred provides the ability to 'tag' users, whether for reference in analytics or any other reason. Note that this is a very simple 'tagging' system, and not something you should use for dynamic tagging situations in your application.
-
-    @user.tag 'awesome'
-    @user.untag 'awesome'
-
-### Firing Events
-
-You can also fire events tied to a specific user - this is helpful for goal tracking and tying actions to a specific user in analytics. We already fire many events for when a user signs up, resets a password, and much more, but you can also use the event system for something more specific for your application.
-
-    # user#fire_event(key, value)
-    @user.fire_event 'task added', @task.name
-
-### Building Referral URLs
-
-To easily build referral URLs to track sharing amongst your users, use `referral_link(my_site)`, where *my_site* is the url that you wish referred users to be sent to.
-
-    current_user.referral_link("http://www.mysite.com")
-
-### Testing Controllers
-
-Testing controllers that have the `authenticate` before filter is easy:
-
-    # with mocha
-    @controller.stubs(:current_user).returns(@user)
-
-See `dummy/test/functional/post_controller_test.rb` for an example.
-
-### Dailycred API
-
-For reference, have a look at the [annotated source code.](https://www.dailycred.com/public/docs/ruby/lib/dailycred.html)
-
-For all API calls, you must first initalize a Dailycred client:
-
-    @dailycred = Dailycred.new "YOUR_CLIENT_ID", "your_secret_key", opts
-
-Where opts is an optional hash for passing options. After initializing your client, you can create events as well as tag and untag users:
-
-    @dailycred.event(current_user.uid, "New Task", @task.name) # user_id, key, value
-    @dailycred.tag(current_user.uid, "Failed Checkout") # user_id, key
-    @dailycred.untag(current_user.uid, "Failed Checkout") # user_id, key
-
-
-### Persona Login
-
-1. Set your `persona audience` in your [dailycred identity provider settings](https://www.dailycred.com/admin/settings/identity-providers). This will be `http://{your-url}/auth/dailycred/callback`.
-2. Make sure you have configured your `callback url` in your [dailycred app settings](https://www.dailycred.com/admin/settings)
-3. In `config/omniauth.rb`, configure your middleware options to include your persona audience:
-
-    Rails.configuration.DAILYCRED_OPTIONS = {
-        middleware: {
-            persona_audience = "http://{your-url}/auth/dailycred/callback"
-        }
-    }
-
-4. In your javascript, call `personaLogin()`.
-
-    $(document).ready(function(){
-        $('.persona-login').click(function(){
-            personaLogin();
-        })
-    })
-
-5. Your user will be redirected to your [persona.org](https://persona.org) to login. If successful, your user will be redirected to your OAuth callback URL and be logged in.
-
-For more details, visit our [persona documentation](https://www.dailycred.com/docs/persona)
-
+## SSL Error
 
-### Configuration
+You may get an error such as the following:
 
-To specify where users should be redirected after authentication actions, setup configure an `after_auth` property on a `Rails.configuration.DAILYCRED_OPTIONS` variable. Example:
+    Faraday::Error::ConnectionFailed (SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed):
 
-    # configure where users should be redirected after authentication
-    #
-    # Rails.configuration.DAILYCRED_OPTIONS = {
-    #   :after_auth => '/hello', #after login
-    #   :after_unauth => '/goodbye' #after logout
-    # }
+If that is the case, consider following fixes explained [here](https://github.com/technoweenie/faraday/wiki/Setting-up-SSL-certificates) or [here](http://martinottenwaelter.fr/2010/12/ruby19-and-the-ssl-error).
 
 ## Contributing
 
@@ -227,6 +71,6 @@ To specify where users should be redirected after authentication actions, setup
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-![](https://www.dailycred.com/dc.gif?client_id=dailycred&title=rails_repo "dailycred")
+omniauth-dailycred
 
-[![Build Status](https://secure.travis-ci.org/dailycred/dailycred.png?branch=master)](https://travis-ci.org/dailycred/dailycred)
+OmniAuth adapter for dailycred using their OAuth2 Strategy

data/Rakefile

@@ -1,43 +1,2 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  # t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-  # Put spec opts in a file named .rspec in root
-end
-
-desc "run travis"
-task :travis do
-  ["rake spec","ruby test/test_helper.rb"].each do |cmd|
-    puts "Starting to run #{cmd}..."
-    system("export DISPLAY=:99.0 && bundle exec #{cmd}")
-    raise "#{cmd} failed!" unless $?.exitstatus == 0
-  end
-end
-
-task :default => :travis
-
-desc 'docs'
-task :docs do
-  begin
-    require 'rocco'
-    require 'rocco/tasks'
-    require 'fileutils'
-    require 'maruku'
-    Rocco::make 'docs/'
-    FileUtils.cp_r "docs/lib/", "/Users/hank/java/dailycred/public/docs/ruby/", :verbose => true
-    md = ""
-    File.open("README.md", "r") do |infile|
-      while (line = infile.gets)
-        md += line
-      end
-    end
-    doc = Maruku.new(md)
-    File.open("/Users/hank/java/dailycred/app/views/tags/docs/rubyonrails.html", 'w') {|f| f.write doc.to_html}
-  rescue LoadError
-    warn "#$! -- rocco tasks not loaded."
-    task :rocco
-  end
-end

data/dailycred.gemspec

@@ -1,20 +1,18 @@
 # -*- encoding: utf-8 -*-=
-require File.expand_path('../lib/dailycred/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Hank Stoever"]
   gem.email         = ["hstove@gmail.com"]
-  gem.description   = %q{A Ruby on Rails engine for authentication with Dailycred.}
-  gem.summary       = %q{}
+  gem.description   = %q{descript}
+  gem.summary       = %q{summary}
   gem.homepage      = "https://www.dailycred.com"
-  gem.add_dependency("omniauth_dailycred")
-  gem.add_dependency("faraday")
-
+  gem.add_dependency("omniauth")
+  gem.add_dependency("omniauth-oauth2")
 
   gem.files         = `git ls-files`.split("\n")
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "dailycred"
   gem.require_paths = ["lib"]
-  gem.version       = Dailycred::VERSION
+  gem.version       = "0.1.21"
 end

data/lib/dailycred.rb

@@ -1 +1,86 @@
-Dir[File.expand_path('../dailycred/*', __FILE__)].each { |f| require f }
+require "omniauth-dailycred/version"
+require "omniauth/strategies/dailycred"
+require "middleware/middleware"
+
+class Dailycred
+
+  attr_accessor :client_id, :secret_key, :options
+
+  # Initializes a dailycred object
+  # @param [String] client_id the client's daiycred client id
+  # @param [String] secret_key the clients secret key
+  # @param [Hash] opts a hash of options
+  def initialize(client_id, secret_key="", opts={})
+    @client_id = client_id
+    @secret_key = secret_key
+    @options = opts
+  end
+
+  URL = "https://www.dailycred.com"
+
+  # Generates a Dailycred event
+  # @param [String] user_id the user's dailycred user id
+  # @param [String] key the name of the event type
+  # @param [String] val the value of the event (optional)
+  def event(user_id, key, val="")
+    opts = {
+      :key => key,
+      :valuestring => val,
+      :user_id => user_id
+    }
+    post "/admin/api/customevent.json", opts
+  end
+
+  # Tag a user in dailycred
+  # @param [String] user_id the user's dailycred user id
+  # @param [String] tag the desired tag to add
+  def tag(user_id, tag)
+    opts = {
+      :user_id => user_id,
+      :tag => tag
+    }
+    post "/admin/api/user/tag.json", opts
+  end
+
+  # Untag a user in dailycred 
+  # (see #tag)
+  def untag(user_id, tag)
+    opts = {
+      :user_id => user_id,
+      :tag => tag
+    }
+    post "/admin/api/user/untag.json", opts
+  end
+
+  private
+
+  def post(url, opts)
+    opts.merge! base_opts
+    p opts
+    response = get_conn.post url, opts
+    p response.body
+  end
+
+  def ssl_opts
+    opts = {}
+    p @options
+    p " ^^^^ @options "
+    if @options[:client_options] && @options[:client_options][:ssl]
+      opts[:ssl] = @options[:client_options][:ssl]
+    end
+    p opts
+    opts
+  end
+
+  def base_opts
+    {
+      :client_id => @client_id,
+      :client_secret => @secret_key
+    }
+  end
+
+  def get_conn
+    p ssl_opts
+    Faraday::Connection.new Dailycred::URL, ssl_opts
+  end
+end

data/lib/generators/dailycred_generator.rb

@@ -1,26 +1,22 @@
-require 'rails/generators'
-require 'pp'
-require 'json'
-require 'faraday'
 class DailycredGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
-  CLIENT_ID_DEFAULT = 'YOUR_CLIENT_ID'
-  CLIENT_SECRET_DEFAULT = 'YOUR_SECRET_KEY'
+  argument :client_id, :type => :string, :default => 'YOUR_CLIENT_ID', :banner => 'dailycred_client_id'
+  argument :secret_key, :type => :string, :default => 'YOUR_SECRET_KEY', :banner => 'dailycred_secret_key'
 
-  argument :client_id, :type => :string, :default => CLIENT_ID_DEFAULT, :banner => 'dailycred_client_id'
-  argument :secret_key, :type => :string, :default => CLIENT_SECRET_DEFAULT, :banner => 'dailycred_secret_key'
+  APP_NAME = Rails.application.class.parent.name
 
   APP_ROUTES_LINES =<<-EOS
-  mount Dailycred::Engine => '/auth', :as => 'dailycred_engine'
+  match '/auth/:provider/callback' => 'sessions#create'
+  match "/logout" => "sessions#destroy", :as => :logout
+  match "/auth" => "sessions#info", :as => :auth
   EOS
 
   APP_CONTROLLER_LINES =<<-EOS
-  helper_method :current_user
+  helper_method :current_user, :login_path, :dailycred, :signup_path
 
   private
 
-  # helper method for getting the current signed in user
   def current_user
     begin
       @current_user || User.find(session[:user_id]) if session[:user_id]
@@ -28,97 +24,53 @@ class DailycredGenerator < Rails::Generators::Base
       nil
     end
   end
+
+  def authenticate
+    redirect_to auth_path unless current_user
+  end
+
+  def signup_path
+    "/auth/dailycred"
+  end
+
+  def login_path
+    "/auth/dailycred?action=signin"
+  end
+
+  def dailycred
+    config = Rails.configuration
+    @dailycred ||= Dailycred.new(config.DAILYCRED_CLIENT_ID, config.DAILYCRED_SECRET_KEY, config.dc_client_opts)
+  end
   EOS
 
   def install
+    dailycred_ascii =<<-EOS
+    *****
+    *****
+    *****
+    *****
+    *****
+    *****    Thanks for using dailycred!
+    *****
+    *****
+    *****
+    *****
+    *****
+    EOS
+    print dailycred_ascii
     # copy initializer
     template "omniauth.rb", "config/initializers/omniauth.rb"
-    # get client info from login if they didnt specify info
-    puts "Please manually configure your API keys in config/initializers/omniauth.rb"
+    # session_controller
+    copy_file "sessions_controller.rb", "app/controllers/sessions_controller.rb"
     # application controller
-    insert_into_file "app/controllers/application_controller.rb", APP_CONTROLLER_LINES, :after => /class ApplicationController\n|class ApplicationController .*\n/
+    inject_into_class "app/controllers/application_controller.rb", ApplicationController, APP_CONTROLLER_LINES
     # add user_model
     copy_file "user.rb", "app/models/user.rb"
     # session_controller
     copy_file "migration_create_user.rb", "db/migrate/#{Time.now.strftime('%Y%m%d%H%M%S')}_create_users.rb"
+    # auth page
+    copy_file "info.html.erb", "app/views/sessions/info"
     # config/routes
-    inject_into_file "config/routes.rb", APP_ROUTES_LINES, :after => ".draw do\n"
-  end
-
-  private
-
-  def get_info first=true
-    if first
-      puts "Please insert your dailycred credentials. You must sign up for a free account at "+
-        "http://www.dailycred.com. This is to automatically configure your api keys. If you wish to skip, enter 'n' as your email."
-    else
-      puts "Invalid email and password. Try again or type 'n' to skip."
-    end
-    #ssl opts
-    # $stderr.puts 'getting input'
-    input = get_input
-    email, password = input[0], input[1]
-    # $stderr.puts 'got input'
-    return if email == "n"
-    ssl_opts = {}
-    if File.exists?('/etc/ssl/certs')
-      ssl_opts = { :ca_path => '/etc/ssl/certs'}
-    end
-    if File.exists?('/opt/local/share/curl/curl-ca-bundle.crt')
-      ssl_opts = { :ca_file => '/opt/local/share/curl/curl-ca-bundle.crt' }
-    end
-    # url = "https://www.dailycred.com"
-    # url = "http://localhost:9000"
-    # staging server for a very short time
-    url = "https://www.dailycred.com"
-    connection = Faraday::Connection.new url, :ssl => ssl_opts
-    params = {
-      :login => email,
-      :pass => password,
-      :client_id => "dailycred"
-    }
-    response = connection.post("user/api/signin.json", params)
-    json = JSON.parse(response.body)
-    if !json["worked"]
-      # wrong password
-      p ''
-      get_info false
-    end
-    access_token = json["access_token"]
-    response = connection.post("graph/clientinfo.json", :access_token => access_token)
-    json = JSON.parse(response.body)
-    if !json["worked"]
-      p "There was an error retrieving your account information. Please manually configure your API keys in config/initializers/omniauth.rb"
-      return
-    end
-    @client_id = json["clientId"]
-    @secret_key = json["clientSecret"]
-    gsub_file("config/initializers/omniauth.rb", /YOUR_CLIENT_ID/, @client_id) if @client_id
-    gsub_file("config/initializers/omniauth.rb", /YOUR_SECRET_KEY/, @secret_key) if @secret_key
-  end
-
-  def get_input
-    puts ''
-    print "Email:"
-    email = gets.chomp
-    return email, nil if email == "n"
-    stty_settings = %x[stty -g]
-    print 'Password: '
-    begin
-      %x[stty -echo]
-      password = gets.chomp
-    ensure
-      %x[stty #{stty_settings}]
-    end
-    p ''
-    return email, password
+    inject_into_file "config/routes.rb", APP_ROUTES_LINES, :after => "#{APP_NAME}::Application.routes.draw do\n"
   end
-
-  private
-
-  def show obj
-    $stderr.puts obj
-  end
-
-
 end

data/lib/generators/templates/info.html.erb

@@ -3,5 +3,5 @@
     <%= link_to 'Logout', logout_path %>
   </p>
 <% else %>
-  <%= link_to 'Login In', login_path(:action => 'signin') %> or <%= link_to 'Sign Up', login_path() %>
+  <%= link_to 'Login In', login_path %> or <%= link_to 'Sign Up', signup_path %>
 <% end %>