freelancer-rails 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gem "freelancer", "0.1.1"

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    freelancer (0.1.1)
+      htmlentities (>= 4.2.1)
+      json_mapper (>= 0.2.1)
+      oauth (>= 0.4.0)
+    htmlentities (4.2.1)
+    json (1.4.6)
+    json_mapper (0.2.1)
+      json (>= 1.4.3)
+    oauth (0.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  freelancer (= 0.1.1)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Trond Arve Nordheim
+
+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.rdoc

@@ -0,0 +1,52 @@
+= Freelancer Rails API
+
+Copyright (C) 2010 Trond Arve Nordheim - {Binary Marbles}[http://www.binarymarbles.com/]
+
+== NOTICE
+
+This is a project under heavy development. The API is far from stable yet, and
+the code is very unclean in some places. The API won't be considered stable
+until all the full Freelancer.com APIs is implemented and have tests verifying
+that they work like they should.
+
+== Description
+
+A Ruby gem for integrating the Freelancer.com API services into a Ruby on Rails application.
+
+== Features
+
+* oAuth authorization
+* Per-environment configuration and sandboxing support, and support from setting API configuration from environment variables.
+
+== Issues and missing features
+
+* No tests yet.
+* No elegant way of hooking into post-authorization-events to retrieve the access token and access secret for storing on the current users profile.
+* No generators available.
+* Lacks documentation.
+
+== Documentation
+
+* RDoc: http://rdoc.info/projects/tanordheim/freelancer-rails
+* Usage: http://wiki.github.com/tanordheim/freelancer-rails
+* Example app: 
+
+== Requirements
+
+* {freelancer}[http://rubygems.org/gems/freelancer]
+
+== Installation
+
+ $ gem install freelancer-rails
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== License
+
+Copyright (c) 2010 Trond Arve Nordheim. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,79 @@
+require "rake"
+require "bundler"
+require "rake/testtask"
+require "rake/rdoctask"
+
+# Gemcutter/Jeweler configuration
+# ----------------------------------------------------------------------------
+begin
+
+  require "jeweler"
+
+  Jeweler::Tasks.new do |gem|
+
+    gem.name = "freelancer-rails"
+    gem.summary = "Freelancer.com API for Ruby on Rails"
+    gem.description = "Ruby on Rails support for the Freelancer.com Ruby gem"
+    gem.email = "tanordheim@gmail.com"
+    gem.homepage = "http://github.com/tanordheim/freelancer-rails"
+    gem.authors = [ "Trond Arve Nordheim" ]
+
+    gem.files = FileList["[A-Z]*", "{app,config,lib,rails}/**/*"]
+    gem.extra_rdoc_files = FileList["[A-Z]*"] - %w(Gemfile Rakefile)
+
+    gem.add_bundler_dependencies
+
+  end
+
+  Jeweler::GemcutterTasks.new
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+# Test setup
+# ----------------------------------------------------------------------------
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib" << "test"
+  t.ruby_opts << "-rubygems"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+# RDoc setup
+# ----------------------------------------------------------------------------
+Rake::RDocTask.new do |rdoc|
+
+  version = File.exists?("VERSION") ? File.read("VERSION") : ""
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "freelancer-rails #{version}"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+
+end
+
+# Rcov setup
+# ----------------------------------------------------------------------------
+begin
+
+  require "rcov/rcovtask"
+
+  Rcov::RcovTask.new do |test|
+
+    test.libs << "test"
+    test.pattern = "test/**/*_test.rb"
+    test.verbose = true
+
+  end
+
+rescue LoadError
+  task :rcov do
+    abort "Rcov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end
+
+# Task setups
+# ----------------------------------------------------------------------------
+task :test => :check_dependencies
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/freelancer/rails/authorizations_controller.rb

@@ -0,0 +1,32 @@
+class Freelancer::Rails::AuthorizationsController < ApplicationController
+
+  include Freelancer::Rails::Controllers::Helpers
+
+  def new
+  end
+
+  def create
+    
+    freelancer_client.set_callback_url(freelancer_oauth_callback_url + "?")
+    session["freelancer_oauth_request_token"] = freelancer_client.request_token.token
+    session["freelancer_oauth_request_secret"] = freelancer_client.request_token.secret
+
+    authorize_url = freelancer_client.request_token.authorize_url
+    redirect_to authorize_url
+
+  end
+
+  def oauth_callback
+
+    request_token = session["freelancer_oauth_request_token"]
+    request_secret = session["freelancer_oauth_request_secret"]
+
+    freelancer_client.authorize_from_request(request_token, request_secret, params[:oauth_verifier])
+    session["freelancer_oauth_access_token"] = freelancer_client.access_token.token
+    session["freelancer_oauth_access_secret"] = freelancer_client.access_token.secret
+
+    redirect_to root_path
+    
+  end
+
+end

data/app/views/freelancer/rails/authorizations/new.html.erb

@@ -0,0 +1,13 @@
+<h1>Freelancer.com authorization required</h1>
+
+<p>
+  The application needs to request authorization from Freelancer.com on your behalf to be able to make requests against the Freelancer.com API.
+</p>
+
+<p>
+  You will now be redirected to Freelancer.com and asked to authorize this application to access the site on your behalf.
+</p>
+
+<% form_tag freelancer_authorize_path do %>
+  <%= submit_tag "I understand, authorize this application" %>
+<% end %>

data/lib/freelancer-rails.rb

@@ -0,0 +1,6 @@
+# Pull in the Freelancer Ruby API
+require "freelancer"
+
+require "freelancer-rails/configuration"
+require "freelancer-rails/routes"
+require "freelancer-rails/controllers/helpers.rb"

data/lib/freelancer-rails/configuration.rb

@@ -0,0 +1,53 @@
+module Freelancer
+  module Rails
+    class Configuration
+
+      class << self
+
+        def api_token
+          configuration["api_token"]
+        end
+
+        def api_secret
+          configuration["api_secret"]
+        end
+
+        def sandbox_mode?
+          configuration["sandbox_mode"] == true
+        end
+
+        private
+        
+        def configuration_file
+          "#{RAILS_ROOT}/config/freelancer.yml"          
+        end
+
+        # Load the system configuration. This will try to load from the configuration
+        # file located in config/freelancer.yml first and use the configuration for the
+        # current environment. If that file can't be found, it will use the environment
+        # variables "FREELANCER_API_TOKEN", "FREELANCER_API_SECRET" and "FREELANCER_SANDBOX_MODE"
+        # instead.
+        def load!
+
+          if File.exists?(configuration_file)
+            @configuration = YAML.load(ERB.new(File.read(configuration_file)).result)[RAILS_ENV]
+          else
+            @configuration = {
+              "api_token" => ENV["FREELANCER_API_TOKEN"],
+              "api_secret" => ENV["FREELANCER_API_SECRET"],
+              "sandbox_mode" => ENV["FREELANCER_SANDBOX_MODE"]
+            }
+          end
+          
+        end
+
+        def configuration
+          load! unless defined?(@configuration)
+          @configuration
+        end
+
+      end
+
+    end
+  end
+end

data/lib/freelancer-rails/controllers/helpers.rb

@@ -0,0 +1,34 @@
+module Freelancer
+  module Rails
+    module Controllers
+      module Helpers
+
+        # Returns the current instance of the Freelancer Client
+        def freelancer_client
+          @freelancer_client ||= Freelancer::Client.new(Freelancer::Rails::Configuration.api_token, Freelancer::Rails::Configuration.api_secret, :sandbox => Freelancer::Rails::Configuration.sandbox_mode?)
+        end
+        
+        # Returns true if the current user session contains an access token
+        def freelancer_access_token?
+          freelancer_access_token != nil          
+        end
+        
+        # Returns the current access token from the user session
+        def freelancer_access_token
+          session["freelancer_oauth_access_token"]
+        end
+        
+        # Returns true if the current user session contains an access secret
+        def freelancer_access_secret?
+          freelancer_access_secret != nil
+        end
+        
+        # Returns the current access secret from the user session
+        def freelancer_access_secret
+          session["freelancer_oauth_access_secret"]
+        end
+        
+      end
+    end
+  end
+end

data/lib/freelancer-rails/routes.rb

@@ -0,0 +1,17 @@
+module Freelancer
+  module Rails
+    class Routes
+
+      def self.draw(map)
+
+        map.namespace(:freelancer) do |freelancer|
+          freelancer.sign_in "sign_in", :controller => "rails/authorizations", :action => "new"
+          freelancer.authorize "authorize", :controller => "rails/authorizations", :action => "create"
+          freelancer.oauth_callback "oauth_callback", :controller => "rails/authorizations", :action => "oauth_callback"
+        end
+        
+      end
+
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "freelancer-rails"

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'freelancer-rails'
+
+class Test::Unit::TestCase
+end

data/test/test_freelancer-rails.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFreelancerRails < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: freelancer-rails
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Trond Arve Nordheim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  name: freelancer
+  prerelease: false
+  version_requirements: *id001
+description: Ruby on Rails support for the Freelancer.com Ruby gem
+email: tanordheim@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- VERSION
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/controllers/freelancer/rails/authorizations_controller.rb
+- app/views/freelancer/rails/authorizations/new.html.erb
+- lib/freelancer-rails.rb
+- lib/freelancer-rails/configuration.rb
+- lib/freelancer-rails/controllers/helpers.rb
+- lib/freelancer-rails/routes.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_freelancer-rails.rb
+has_rdoc: true
+homepage: http://github.com/tanordheim/freelancer-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Freelancer.com API for Ruby on Rails
+test_files: 
+- test/helper.rb
+- test/test_freelancer-rails.rb