flattr 0.2.1 → 0.2.2

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - rbx
+  - ree

data/README.md

@@ -1,14 +1,97 @@
-# Flattr
+# Flattr API wrapper gem
 
-This gem is a wrapper around version 2 of the [Flattr](http://flattr.com) [REST
-API](http://developers.flattr.com/v2).
+This gem is a wrapper around the Flattr API. With the gem you can search things, add new thing and much more.
 
 ## Build status
 
 [![Build
 Status](https://secure.travis-ci.org/simon/flattr.png)](http://travis-ci.org/simon/flattr)
 
-## Examples
+## Installation
+
+Installation is easy, just install the gem with.
+
+`gem install flattr`
+
+### Dependencies
+
+  * Faraday
+  * multi_json
+
+## Usage
+
+To talk with all of Flattr API resources you need to [register a application](http://flattr.com/apps). This will give you a *client id* and a *client secret* whom you can exchange for a *access token*. The *access token* is then used to access the resources in the Flattr API that needs authentication. You can find more information about the API in [Flattr developer documents](http://developers.flattr.net/v2).
+
+### Access public resources
+
+There are several public available resources in the Flattr API where you don't need to authenticate to access.
+
+```ruby
+# Fetch a public thing
+flattr = Flattr.new
+
+flattr.thing 423405
+# => #<Flattr::Thing:0x007fccbb4f1d40 @attrs={"type"=>"thing", "resource"=>"https://api.flattr.com/rest/v2/things/423405", "link"=>"https://flattr.com/thing/423405", "id"=>423405, "url"=>"http://blog.flattr.net/2011/10/api-v2-beta-out-whats-changed/", "language"=>"en_GB", "category"=>"text", "owner"=>{"type"=>"user", "resource"=>"https://api.flattr.com/rest/v2/users/flattr", "link"=>"https://flattr.com/profile/flattr", "username"=>"flattr"}, "hidden"=>false, "created_at"=>1319704532, "tags"=>["api"], "flattrs"=>9, "description"=>"We have been working hard to deliver a great experience for developers and tried to build a good foundation for easily add new features. The API will remain in beta for a while for us to kill quirks and refine some of the resources, this means there might be big changes without notice for ...", "title"=>"API v2 beta out – what’s changed?"}>
+```
+
+### Access protected resources
+
+The gem allows makes it easy to do the oauth2 dance.
+
+```ruby
+Flattr.configure do |config|
+  config.client_id = '1234'
+  config.client_secret = '4567'
+end
+
+flattr = Flattr.new
+
+puts 'Open this URL in your browser to authenticate your application'
+puts flattr.authorize_url
+
+puts "\n\n"
+
+puts 'When your with the authentication the browser will redirect you to the callback URL you specified when creating a application. It has also included a code in the query string. Copy paste this code to the command line.'
+print 'code: '
+code = gets
+
+# Use the code and exchange it for a access_token
+flattr.get_access_token code
+
+# You are now authorized! ;)
+
+```
+
+### Scopes available
+
+If you request a access token without any scopes you won't be able to flattr other users things and such. The scopes available are:
+
+* `thing` - Create and update things
+* `flattr` - Flattr things
+* `extendedread` - Access all the information about users
+
+## What needs to be done
+
+* Add error reporting
+* More tests are needed, coverage isn't that good
+* Add all the Flattr API resources
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against](http://travis-ci.org/simon/flattr) the following Ruby implementations:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+* JRuby
+* Rubinius
+* Ruby Enterprise Edition
+
+If something doesn't work on one of these interpreters, it should be considered a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the versions listed above.
+
+If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be personally responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.
 
 ## Copyright
 

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/flattr.gemspec

@@ -7,9 +7,8 @@ Gem::Specification.new do |s|
   s.version     = Flattr::Version.to_s
   s.authors     = ["Simon Gate", "Joel Hansson"]
   s.email       = ["simon@smgt.me", "joel.hansson@gmail.com"]
-  s.homepage    = ""
-  s.summary     = %q{Write a gem summary}
-  s.description = %q{Write a gem description}
+  s.homepage    = "http://github.com/simon/flattr"
+  s.summary     = %q{Flattr API wrapper}
 
   s.rubyforge_project = "flattr"
 
@@ -21,7 +20,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday'
   s.add_dependency 'multi_json'
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency 'json'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdiscount'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
 end

data/lib/flattr/client.rb

@@ -47,5 +47,10 @@ module Flattr
       @current_user ||= Flattr::User.new(self.verify_credentials)
     end
 
+    def base64_encode str
+      [str].pack("m9999").chomp
+    end
+
+
   end
 end

data/lib/flattr/connection.rb

@@ -6,7 +6,7 @@ require 'flattr/request/oauth2'
 module Flattr
   module Connection
   private
-    def connection(options={})
+    def connection(connection_options={})
       default_options = {
         :headers => {
           :accept => 'application/json',
@@ -14,14 +14,14 @@ module Flattr
         },
         :proxy => proxy,
         :ssl => {:verify => false},
-        :url => options.fetch(:endpoint, endpoint),
+        :url => endpoint,
       }
       Faraday.new(default_options.deep_merge(connection_options)) do |builder|
         #builder.use Faraday::Request::Multipart
         builder.use Faraday::Request::JSON
         builder.use Faraday::Request::UrlEncoded
         builder.use Flattr::Request::FlattrOAuth2, credentials if credentials?
-        builder.use Flattr::Response::ParseJson unless options[:raw]
+        builder.use Flattr::Response::ParseJson unless connection_options[:raw]
         builder.adapter(adapter)
       end
     end

data/lib/flattr/oauth2.rb

@@ -1,7 +1,7 @@
 module Flattr
   module OAuth2
 
-    def authorize_path(opts = {})
+    def authorize_url(opts = {})
 
       default_options = {
         :client_id => client_id,
@@ -25,7 +25,16 @@ module Flattr
     end
 
     def get_access_token(code)
-      post(token_endpoint, {:code => code, :grant_type => 'authorization_code'}, options)
+      response = post(token_endpoint, {
+        :code => code,
+        :grant_type => 'authorization_code'
+      },{
+        :headers => {
+          :authorization => "Basic #{base64_encode("#{client_id}:#{client_secret}")}"
+        }}
+      )
+      self.access_token = response['access_token']
+      access_token
     end
 
   end

data/lib/flattr/request/oauth2.rb

@@ -23,10 +23,6 @@ module Flattr
         end
       end
 
-      def base64_encode str
-        [str].pack("m9999").chomp
-      end
-
     end
   end
 end

data/lib/flattr/version.rb

@@ -13,7 +13,7 @@ module Flattr
 
   # @return [Integer]
   def self.patch
-    1
+    2
   end
 
   # @return [String, NilClass]

data/spec/flattr_spec.rb

@@ -0,0 +1,70 @@
+require 'helper'
+
+describe Flattr do
+  after do
+    Flattr.reset
+  end
+
+  describe '.respond_to?' do
+    it "should take an optional argument" do
+      Flattr.respond_to?(:new, true).should be_true
+    end
+  end
+
+  describe ".new" do
+    it "should return a Flattr::Client" do
+      Flattr.new.should be_a Flattr::Client
+    end
+  end
+
+  describe ".adapter" do
+    it "should return the default adapter" do
+      Flattr.adapter.should == Flattr::Config::DEFAULT_ADAPTER
+    end
+  end
+
+  describe ".adapter=" do
+    it "should set the adapter" do
+      Flattr.adapter = :typhoeus
+      Flattr.adapter.should == :typhoeus
+    end
+  end
+
+  describe ".endpoint" do
+    it "should return the default endpoint" do
+      Flattr.endpoint.should == Flattr::Config::DEFAULT_ENDPOINT
+    end
+  end
+
+  describe ".endpoint=" do
+    it "should set the endpoint" do
+      Flattr.endpoint = 'http://tumblr.com/'
+      Flattr.endpoint.should == 'http://tumblr.com/'
+    end
+  end
+
+  describe ".user_agent" do
+    it "should return the default user agent" do
+      Flattr.user_agent.should == Flattr::Config::DEFAULT_USER_AGENT
+    end
+  end
+
+  describe ".user_agent=" do
+    it "should set the user_agent" do
+      Flattr.user_agent = 'Custom User Agent'
+      Flattr.user_agent.should == 'Custom User Agent'
+    end
+  end
+
+  describe ".configure" do
+    Flattr::Config::VALID_OPTIONS_KEYS.each do |key|
+      it "should set the #{key}" do
+        Flattr.configure do |config|
+          config.send("#{key}=", key)
+          Flattr.send(key).should == key
+        end
+      end
+    end
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,38 @@
+require 'simplecov'
+SimpleCov.start
+require 'flattr'
+require 'rspec'
+require 'webmock/rspec'
+
+def a_delete(path, endpoint=Flattr.endpoint)
+  a_request(:delete, endpoint + path)
+end
+
+def a_get(path, endpoint=Flattr.endpoint)
+  a_request(:get, endpoint + path)
+end
+
+def a_post(path, endpoint=Flattr.endpoint)
+  a_request(:post, endpoint + path)
+end
+
+def a_put(path, endpoint=Flattr.endpoint)
+  a_request(:put, endpoint + path)
+end
+
+def stub_delete(path, endpoint=Flattr.endpoint)
+  stub_request(:delete, endpoint + path)
+end
+
+def stub_get(path, endpoint=Flattr.endpoint)
+  stub_request(:get, endpoint + path)
+end
+
+def stub_post(path, endpoint=Flattr.endpoint)
+  stub_request(:post, endpoint + path)
+end
+
+def stub_put(path, endpoint=Flattr.endpoint)
+  stub_request(:put, endpoint + path)
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flattr
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-10 00:00:00.000000000Z
+date: 2011-12-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70096099213560 !ruby/object:Gem::Requirement
+  requirement: &70325557419160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70096099213560
+  version_requirements: *70325557419160
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70096099213060 !ruby/object:Gem::Requirement
+  requirement: &70325557417700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,8 +33,74 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70096099213060
-description: Write a gem description
+  version_requirements: *70325557417700
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70325557416920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70325557416920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70325557406820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70325557406820
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70325557406000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70325557406000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70325557405480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70325557405480
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70325557405020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70325557405020
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70325557404500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70325557404500
+description: 
 email:
 - simon@smgt.me
 - joel.hansson@gmail.com
@@ -43,6 +109,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.md
 - README.md
@@ -77,7 +145,9 @@ files:
 - lib/flattr/thing.rb
 - lib/flattr/user.rb
 - lib/flattr/version.rb
-homepage: ''
+- spec/flattr_spec.rb
+- spec/helper.rb
+homepage: http://github.com/simon/flattr
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -100,5 +170,7 @@ rubyforge_project: flattr
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Write a gem summary
-test_files: []
+summary: Flattr API wrapper
+test_files:
+- spec/flattr_spec.rb
+- spec/helper.rb