dailycred 0.1.22 → 0.1.23

data/README.md

@@ -1,67 +1,8 @@
 # Dailycred
 
-## Installation
+## Rails gem for instant authentication using Dailycred with Ruby on Rails
 
-Add this line to your application's Gemfile: 
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install omniauth-dailycred
-
-## Usage
-
-bash
-    
-    rails g dailycred YOUR_CLIENT_ID YOUR_SECRET_KEY
-    rake db:migrate
-
-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)
-
-##### Authentication
-
-Use the `:authenticate` helper to require a user to be signed in:
-
-    before_filter :authenticate
-
-The current user object can be located with `current_user`:
-
-    # in posts_controller
-
-    @posts = currrent_user.posts.all
-
-##### Using only with Omniauth
-
-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
-
-    provider :dailycred, 'CLIENT_ID', 'SECRET_KEY'
-
-##### Events
-
-To fire an event to be logged in Dailycred:
-
-    #in your controller
-
-    before_filter :dailycred
-
-    def create
-      ...
-
-      # after successfully saving the model:
-      @dailycred.event(current_user.uid, 'Created Post', @post.name)
-
-    end
-
-## SSL Error
-
-You may get an error such as the following:
-
-    Faraday::Error::ConnectionFailed (SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed):
-
-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).
+### Check out the documenation at [dailycred.com]("https://www.dailycred.com/docs/ruby")
 
 ## Contributing
 
@@ -70,7 +11,3 @@ If that is the case, consider following fixes explained [here](https://github.co
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-omniauth-dailycred
-
-OmniAuth adapter for dailycred using their OAuth2 Strategy

data/Rakefile

@@ -10,3 +10,13 @@ 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
+
+begin
+  require 'rocco/tasks'
+  require 'fileutils'
+  Rocco::make 'docs/'
+  FileUtils.cp_r "docs/lib/", "/Users/hank/rails/dailycred/public/docs/ruby/"
+rescue LoadError
+  warn "#$! -- rocco tasks not loaded."
+  task :rocco
+end

data/dailycred.gemspec

@@ -14,5 +14,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "dailycred"
   gem.require_paths = ["lib"]
-  gem.version       = "0.1.22"
+  gem.version       = "0.1.23"
 end

data/lib/dailycred.rb

@@ -14,9 +14,10 @@ class Dailycred
   }
 
   # 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
+  #
+  # - @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
@@ -26,9 +27,10 @@ class Dailycred
   end
 
   # 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)
+  #
+  # - @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,
@@ -39,8 +41,9 @@ class Dailycred
   end
 
   # Tag a user in dailycred
-  # @param [String] user_id the user's dailycred user id
-  # @param [String] tag the desired tag to add
+  #
+  # - @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,

data/lib/middleware/middleware.rb

@@ -53,13 +53,13 @@ class Dailycred
         document.body.appendChild(dc);
       }).call(this);
       </script>
-      <script src="#{@opts[:url]}/public/js/dailycred.coffee"></script>
+      <!--<script src="#{@opts[:url]}/public/js/dailycred.coffee"></script>
       <script>
       DC.init({
           "showModal" : #{@opts[:modal]},
           "triggers"  : #{@opts[:triggers].to_s}
         });
-      </script>
+      </script>-->
       <!-- end dailycred -->
       EOT
     end

data/lib/omniauth/strategies/dailycred.rb

@@ -4,17 +4,22 @@ require 'net/https'
 require 'json'
 require 'pp'
 
+# #The Dailycred Omniauth Strategy
 module OmniAuth
   module Strategies
     class Dailycred < OmniAuth::Strategies::OAuth2
 
+      # default options
       option :client_options, {
         :site => "https://www.dailycred.com",
         :authorize_url => '/oauth/authorize',
         :token_url => '/oauth/access_token'
       }
 
+      # parameters to expect and return from dailycred responses
       ATTRIBUTES = ["email", "username", "created", "verified", "admin", "referred_by", "tags", "referred"]
+
+      # allows parameters to be passed through
       AUTH_PARAMS = ["action"]
 
       option :authorize_options, OmniAuth::Strategies::Dailycred::AUTH_PARAMS
@@ -34,6 +39,7 @@ module OmniAuth
         end
       end
 
+      # this step allows auth_params to be added to the url
       def request_phase
         OmniAuth::Strategies::Dailycred::AUTH_PARAMS.each do |param|
           val = session['omniauth.params'][param]
@@ -47,11 +53,10 @@ module OmniAuth
 
       private
 
+      # This is the phase where the gem calls me.json, which returns information about the user
       def user
         return @duser if !@duser.nil?
-        connection = Faraday::Connection.new options.client_options[:site], :ssl => {
-          :ca_file => "/opt/local/share/curl/curl-ca-bundle.crt"
-        }
+        connection = Faraday::Connection.new options.client_options[:site], options.client_options[:ssl]
         response = connection.get("/graph/me.json?access_token=#{access_token.token}")
         json = JSON.parse(response.body)
         pp json

data/spec/support/dailycred_spec.rb

@@ -11,7 +11,7 @@ describe Dailycred do
     secret = "6925d89e-d04d-469e-8fc9-3782af57bc29-c2340f1e-25a0-40af-b638-7429947a6cd7"
     @user_id = "0c19c355-2a71-4c8e-805e-f7a6087ea84c"
 
-    #dev settings
+    # dev settings
     # site = "http://localhost:9000"
     # client_id = "4337ed55-aaca-4e38-8824-6c016c59dd5b"
     # secret = "34f2ecc3-f955-4292-9747-39b876d91d8b-a4f7ad8e-f8a4-4573-b23d-686f6e28a820"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dailycred
 version: !ruby/object:Gem::Version
-  version: 0.1.22
+  version: 0.1.23
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2012-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth