br_api_fantasy 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+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.markdown

@@ -0,0 +1,47 @@
+Br Fantasy Api Plugin
+================
+
+Talk to Br Fantasy Api from your Rails app to get user info.
+
+Installation:
+------------
+
+<pre>
+$ gem install br_api_fantasy --no-ri --no-rdoc
+</pre>
+
+Copy br_api_fantasy.example.yml to rails_project/config/br_api_fantasy.yml.  Update the api_key to the
+one given to you by Bleacher Report.
+
+Usage:
+------------
+
+After a user logs in or signs up from one of the Bleacher Report's fantasy branded pages, they will be redirected to the passthrough params[:return_to] url, which can be set by the Fantasy Games 3rd party, along with a token (user_token). The 3rd party can use the token to then generate the verified hash on their servers.  BR will generate the same hash and compare against it to ensure it's coming from a trusted source. 
+
+The plugin contains the method to generate the api request, this method will use the api_key configured in br_api_fantasy.yml:
+
+Br::Api::Fantasy.authenticate('user-token-returned-from-login-page')
+
+Example:
+------------
+<pre>
+$ ./script/console 
+>> pp Br::Api::Fantasy.authenticate('foobar-invalid-token')
+{"response_details"=>"user with fantasy token foobar-invalid-token not found",
+ "response_data"=>nil,
+ "response_summary"=>"user not found",
+ "response_status"=>200}
+=> nil
+>> pp Br::Api::Fantasy.authenticate('8681576f47b87b2988bdc76262164cda00019986')
+{"response_details"=>"signature successfully matched",
+ "response_data"=>
+  {"user_last_name"=>"McCormick",
+   "user_first_name"=>"Kenny",
+   "user_permalink"=>"http://breport.local/users/309596-kenny-mccormick",
+   "user_id"=>309596},
+ "response_summary"=>"login success",
+ "response_status"=>200}
+=> nil
+>> 
+</pre>
+

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'gemspec'
+
+desc "Generate gemspec"
+task :gemspec do
+  File.open("#{Dir.pwd}/#{GEM_NAME}.gemspec", 'w') do |f|
+    f.write(GEM_SPEC.to_ruby)
+  end
+end
+
+task :uninstall do
+  sudo = ENV['SUDO'].nil? ? '' : 'sudo '
+  `#{sudo} gem uninstall #{GEM_NAME} -x`
+end
+
+desc "Install gem"
+task :install do
+  sudo = ENV['SUDO'].nil? ? '' : 'sudo '
+  Rake::Task['gem'].invoke
+  `#{sudo} gem install pkg/#{GEM_NAME}*.gem`
+  `rm -Rf pkg`
+end
+
+desc "Package gem"
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.gem_spec = GEM_SPEC
+end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end
+

data/config/br_api_fantasy.example.yml

@@ -0,0 +1,18 @@
+# This belongs in rails_app/config/br_api_fantasy.yml.  Adjust the api_key accordingly.
+
+development: &defaults
+  api_uri: http://breport.local
+  api_key: "southparkrocks"
+  default_return_to: http://games.stagingbleacherreport.com
+
+test:
+  <<: *defaults
+
+staging:
+  api_uri: http://beta.stagingbleacherreport.com
+  <<: *defaults
+
+production:
+  api_uri: http://beta.stagingbleacherreport.com
+  default_return_to: http://games.stagingbleacherreport.com
+  <<: *defaults

data/gemspec.rb

@@ -0,0 +1,39 @@
+GEM_NAME = 'br_api_fantasy'
+GEM_FILES = FileList['**/*'] - FileList['coverage', 'coverage/**/*', 'pkg', 'pkg/**/*']
+GEM_SPEC = Gem::Specification.new do |s|
+  # == CONFIGURE ==
+  s.author = "Tung Nguyen"
+  s.email = "tongueroo@gmail.com"
+  s.homepage = "http://github.com/tongueroo/#{GEM_NAME}"
+  s.summary = ""
+  # == CONFIGURE ==
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files = GEM_FILES.to_a
+  s.has_rdoc = false
+  s.name = GEM_NAME
+  s.platform = Gem::Platform::RUBY
+  s.require_path = "lib"
+  s.version = "0.1.0"
+  
+  path = File.dirname(__FILE__)+"/config/br_api_fantasy.example.yml"
+  yaml_instructions =  IO.read(path)
+  s.post_install_message = <<-POST_INSTALL_MESSAGE
+#{'*'*50}
+
+Thanks for installing br_api_fantasy-#{s.version}.
+
+Please make sure to add the gem to your rails project.
+
+Rails::Initializer.run do |config|
+  ...
+  config.gem 'br_api_fantasy', :version => #{s.version}
+  ...
+end
+
+Also, please make sure you have the following in rails_app/config/br_api_fantasy.yml.
+
+#{yaml_instructions}
+    
+#{'*'*50}
+  POST_INSTALL_MESSAGE
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/br_api_fantasy.rb

@@ -0,0 +1,41 @@
+require 'httparty'
+require 'yaml'
+require 'digest/sha1'
+
+module Br
+  module Api
+    class Fantasy
+      include HTTParty
+
+      cattr_accessor :config_path
+      cattr_accessor :credentails
+      self.config_path = File.join(RAILS_ROOT,'config','br_api_fantasy.yml')
+
+      def self.parse_creds
+        path = File.expand_path(self.config_path)
+        YAML.load(IO.read(path))[RAILS_ENV]
+      end
+      self.credentails = parse_creds
+
+      def self.sig(token)
+        Digest::SHA1.hexdigest("--#{credentails['api_key']}--#{token}--")
+      end
+
+      def self.authenticate(token)
+        base_uri credentails['api_uri']
+        response = get '/api/fantasy/authenticate.json', :query => {:token => token, :sig => sig(token)}
+        if response.is_a?(Hash)
+          return response
+        elsif response.is_a?(String)
+          return {
+            :response_status => 500,
+            :response_details => "500 Error",
+            :response_data => response
+          }
+        else
+          raise "response is not a Hash or String #{response.class}"
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/br_api_fantasy")

data/spec/br_api_fantasy_spec.rb

@@ -0,0 +1,49 @@
+# mock rails
+require "rubygems"
+require "activesupport"
+require "logger"
+RAILS_ENV="test"
+RAILS_ROOT = File.expand_path(File.dirname(__FILE__)+"/example_app")
+RAILS_DEFAULT_LOGGER=Logger.new(RAILS_ROOT+"/log/test.log")
+
+require "lib/br_api_fantasy"
+
+Spec::Runner.configure do |config|
+end
+
+# stub out the httparty get request
+puts "ENV['LIVE_TEST'] #{ENV['LIVE_TEST'].inspect}"
+LIVE_TEST = !ENV['LIVE_TEST'].nil?
+# note do do a live test, you'll need to grab a real token from the live api you are ping
+unless LIVE_TEST
+  require 'httparty'
+  module HTTParty
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+    module ClassMethods
+      def get(url, options)
+        {:mock_json => true}
+      end
+    end
+  end
+end
+
+describe Br::Api::Fantasy do
+  before(:each) do
+    Br::Api::Fantasy.config_path = RAILS_ROOT+"/config/br_api_fantasy.yml"
+    @token = "1bd31ce33c85ea5cdc3166166dbdd170e92dc3a5"
+  end
+  it "parse credentials" do
+    creds = Br::Api::Fantasy.parse_creds
+    creds['api_uri'].should == 'http://breport.local'
+  end
+  it "generate signature" do
+    sig = Br::Api::Fantasy.sig(@token)
+    sig.length.should == 40
+  end
+  it "authenticate" do
+    json = Br::Api::Fantasy.authenticate(@token)
+    json.should be_kind_of(Hash)
+  end
+end

data/spec/example_app/config/br_api_fantasy.yml

@@ -0,0 +1,16 @@
+development: &defaults
+  api_uri: http://breport.local
+  api_key: "southparkrocks"
+  default_return_to: http://games.stagingbleacherreport.com
+
+test:
+  <<: *defaults
+
+staging:
+  api_uri: http://beta.stagingbleacherreport.com
+  <<: *defaults
+
+production:
+  api_uri: http://beta.stagingbleacherreport.com
+  default_return_to: http://games.stagingbleacherreport.com
+  <<: *defaults

data/spec/example_app/log/test.log

@@ -0,0 +1 @@
+# Logfile created on Mon Jul 12 20:59:58 -0700 2010 by logger.rb/22283

data/spec/test.log

@@ -0,0 +1 @@
+# Logfile created on Mon Jul 12 20:56:09 -0700 2010 by logger.rb/22283

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: br_api_fantasy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tung Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tongueroo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- config/br_api_fantasy.example.yml
+- gemspec.rb
+- init.rb
+- lib/br_api_fantasy.rb
+- MIT-LICENSE
+- rails/init.rb
+- Rakefile
+- README.markdown
+- spec/br_api_fantasy_spec.rb
+- spec/example_app/config/br_api_fantasy.yml
+- spec/example_app/log/test.log
+- spec/test.log
+has_rdoc: true
+homepage: http://github.com/tongueroo/br_api_fantasy
+licenses: []
+
+post_install_message: |
+  **************************************************
+  
+  Thanks for installing br_api_fantasy-0.1.0.
+  
+  Please make sure to add the gem to your rails project.
+  
+  Rails::Initializer.run do |config|
+    ...
+    config.gem 'br_api_fantasy', :version => 0.1.0
+    ...
+  end
+  
+  Also, please make sure you have the following in rails_app/config/br_api_fantasy.yml.
+  
+  # This belongs in rails_app/config/br_api_fantasy.yml.  Adjust the api_key accordingly.
+  
+  development: &defaults
+    api_uri: http://breport.local
+    api_key: "southparkrocks"
+    default_return_to: http://games.stagingbleacherreport.com
+  
+  test:
+    <<: *defaults
+  
+  staging:
+    api_uri: http://beta.stagingbleacherreport.com
+    <<: *defaults
+  
+  production:
+    api_uri: http://beta.stagingbleacherreport.com
+    default_return_to: http://games.stagingbleacherreport.com
+    <<: *defaults
+  
+      
+  **************************************************
+
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: []
+