baloo 0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in baloo.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Butler
+
+MIT License
+
+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.md

@@ -0,0 +1,58 @@
+# Baloo
+
+The simple 'bear' necessities for working with graph.facebook.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'baloo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install baloo
+
+## Usage
+
+```ruby
+  # configure
+  # only required if you're going to do stuff with your app access token later
+  Baloo.configure :app_id => '...', :app_secret => '...', app_namespace => '...'
+
+  #get /me
+  Baloo.get 'me', :query => {:access_token => '...'}
+  # => {...} # a facebook user hash
+
+  # post 
+  Baloo.post 'me/albums', :body => {:access_token => '...', :name => 'Baloo Album'}
+  # => {"id": "..."}
+
+  # app access token / client credentials
+  # Baloo#app_token is an alias for Baloo#client_credentials
+  Baloo.app_token
+  # => "your_app_token"
+
+  Baloo.client_credentials
+  # => "same_thing"
+
+  Baloo.app_token(app_id, app_secret)
+  # => "app token for some other app"
+
+  # Batch Requests
+  batch = Baloo::BatchRequest.new
+  25.times { batch.add :get, 'betapond' }
+  batch.perform {|res| puts res['body']['id'] }
+  # => 158724218692 (25 times)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/baloo.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/baloo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Butler"]
+  gem.email         = ["johnnypez@gmail.com"]
+  gem.description   = %q{The simple 'bear' necessities for working with graph.facebook.com}
+  gem.summary       = %q{A simple Facebook Graph client}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "baloo"
+  gem.require_paths = ["lib"]
+  gem.version       = Baloo::VERSION
+
+  gem.add_dependency "httparty"
+  gem.add_dependency "activesupport"
+end

data/lib/baloo/batch_request.rb

@@ -0,0 +1,41 @@
+require 'yajl'
+module Baloo
+  class BatchRequest
+
+    Limit = 20
+    
+    attr_accessor :requests, :responses
+
+    def initialize
+      @requests = []
+      @responses = []
+    end
+
+    def add(method, path, body = {})
+      request = { :method => method, :relative_url => path }
+      unless body.empty?
+        request[:body] = HTTParty::HashConversions.to_params(body)
+      end
+      @requests << request
+    end
+
+    # peform the batch request
+    # the passed block will recieve each response as it is parsed
+    def perform(&block)
+      raise Exception.new("You must have at least 2 requests") unless @requests.length > 1
+      @responses.clear
+      requests.each_slice(Limit).to_a.each do |batch|
+        body = {
+          :batch => Yajl::Encoder.encode(batch),
+          :access_token => Baloo.client_credentials
+        }
+        Client.post("/", :body => body).each do |response|
+          # response['headers'] = Yajl::Parser.parse(response['headers'])
+          response['body'] = Yajl::Parser.parse(response['body'])
+          yield response
+        end
+      end
+    end
+
+  end
+end

data/lib/baloo/client.rb

@@ -0,0 +1,27 @@
+module Baloo
+  class Client
+    include HTTParty
+
+    base_uri "https://graph.facebook.com"
+    parser Parser
+    format :plain
+
+    private
+    # overrides HTTParty#perform_request to handle exceptions and http errors
+    def self.perform_request(http_method, path, options, &block) #:nodoc:
+      response = super
+      case response.response
+        when Net::HTTPSuccess
+          response
+        when Net::HTTPClientError, Net::HTTPServerError
+          raise HTTPError.new(response)
+        else
+          # unknown http error, raise it
+          response.response.error!
+      end
+
+      rescue Net::ProtocolError, Timeout::Error, Errno::ETIMEDOUT, Errno::ECONNRESET
+        raise NetworkError.new
+    end
+  end
+end

data/lib/baloo/convenience.rb

@@ -0,0 +1,21 @@
+module Baloo
+  module Convenience
+
+    # get an app access token
+    def client_credentials(id = Baloo.app_id, secret = Baloo.app_secret)
+      @stored_client_credentials ||= {}
+      unless @stored_client_credentials[id]
+        params = {
+        :client_id => id,
+        :client_secret => secret,
+        :grant_type => 'client_credentials'
+        }
+        @stored_client_credentials[id] = get('oauth/access_token', :query => params).split("=")[1]
+      end
+
+      @stored_client_credentials[id]
+    end
+    alias :app_token :client_credentials
+
+  end
+end

data/lib/baloo/error.rb

@@ -0,0 +1,29 @@
+module Baloo
+  
+  class Error < StandardError
+  end
+
+  class HTTPError < Error
+    attr_reader :response
+    MessageFormat = "%s %s => %s \n %s"
+
+    def initialize(response)
+      @response = response
+      super sprintf(MessageFormat, response.request.http_method, response.request.uri, response.response.class, response.body)
+    end
+  end
+
+  class NetworkError < Error
+    attr_reader :original
+
+    def initialize(original = $!)
+      if original.nil?
+        super
+      else
+        super(original.message)
+      end
+      @original = original
+    end
+  end
+
+end

data/lib/baloo/parser.rb

@@ -0,0 +1,23 @@
+require 'yajl'
+module Baloo
+  class Parser < HTTParty::Parser
+
+    def parse
+      if /^true|false$/.match(body)
+        bool
+      elsif /^\{|\[.+\}|\]$/.match(body)
+        json
+      else
+        body
+      end
+    end
+
+    def json
+      Yajl::Parser.parse(body)
+    end
+
+    def bool
+      body =~ /^true$/ ? true : false
+    end
+  end
+end

data/lib/baloo/version.rb

@@ -0,0 +1,3 @@
+module Baloo
+  VERSION = "0.1"
+end

data/lib/baloo.rb

@@ -0,0 +1,50 @@
+require "active_support/core_ext"
+require "httparty"
+
+require "baloo/error"
+require "baloo/parser"
+require "baloo/client"
+require "baloo/version"
+require "baloo/convenience"
+require "baloo/batch_request"
+
+module Baloo
+
+  class << self
+
+    attr_accessor :app_id
+    attr_accessor :app_secret
+    attr_accessor :app_namespace
+
+    include Convenience
+
+    def configure(options = {})
+      options.stringify_keys!
+      %w(app_id app_secret app_namespace).each {|opt| send("#{opt}=", options[opt])}
+    end
+
+    %w(get post put delete head).each do |http_method|
+      define_method "#{http_method}" do |*args|
+        slasherize args
+        response = Client.send(http_method, *args)
+        if block_given?
+          yield response.parsed_response
+        else
+          response.parsed_response
+        end
+      end
+    end
+    
+    private
+
+    # ensure path starts with a forwardslash
+    def slasherize(args)
+      if args.first && args.first.is_a?(String)
+        args[0] = ("/" << args.first) unless args.first =~ /^\//
+      end
+
+      args
+    end
+
+  end
+end

data/spec/batch_request_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Baloo::BatchRequest do
+
+  it "should bloody well work!" do
+    Baloo.configure :app_id => "204876786306406", :app_secret => "34dc50cea8b8bbdf1dba1018c9aebc90", :app_namespace => "baloo_test"
+
+    batch = Baloo::BatchRequest.new
+    batch.add :get, '582470824'
+    batch.add :post, '582470824/albums', :name => "Foo Album"
+    25.times { batch.add :get, 'betapond' }
+
+    responses = []
+    batch.perform do |response|
+      responses << response
+      response['code'].class.should eq Fixnum
+    end
+    
+    responses.count.should eq 27
+    responses[0]['body'].class.should eq Hash
+    responses[0]['headers'].class.should eq Array
+
+    responses[0]['body']['username'].should eq 'johnnypez'
+    responses[1]['code'].should eq 400 # no access token was give so Bad Request is expected
+    responses[3]['code'].should eq 200
+  end
+
+end

data/spec/client_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Baloo do
+
+  it "should allow configuration for a fb app" do
+    Baloo.app_id.should be nil
+    Baloo.app_secret.should be nil
+    Baloo.app_namespace.should be nil
+
+    Baloo.configure :app_id => 1, :app_secret => 2, :app_namespace => "test"
+
+    Baloo.app_id.should eq 1
+    Baloo.app_secret.should eq 2
+    Baloo.app_namespace.should eq "test"
+  end
+  
+  it "should allow starting forwardslash or not" do
+    res = Baloo.get 'theo2'
+    res.class.should eq Hash
+    Baloo.get(res['id'])['id'].should eq res['id']
+    Baloo.get('/theo2')['id'].should eq res['id']
+  end
+
+  it "should allow t/f in the response" do
+    res = Baloo.get 'boylesports'
+    res.class.should eq FalseClass
+  end
+
+  it "should handle errors like a boss!" do
+    expect { Baloo.get 'me' }.to raise_error Baloo::HTTPError
+  end
+
+end

data/spec/convenience_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Baloo::Convenience do
+  
+  it "should support retrieval of app access tokens" do
+    Baloo.configure :app_id => "204876786306406", :app_secret => "34dc50cea8b8bbdf1dba1018c9aebc90", :app_namespace => "baloo_test"
+    Baloo.client_credentials.should match(/^204876786306406\|.+/)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/baloo")

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: baloo
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- John Butler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-16 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70121616862160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121616862160
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70121616861140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121616861140
+description: The simple 'bear' necessities for working with graph.facebook.com
+email:
+- johnnypez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- baloo.gemspec
+- lib/baloo.rb
+- lib/baloo/batch_request.rb
+- lib/baloo/client.rb
+- lib/baloo/convenience.rb
+- lib/baloo/error.rb
+- lib/baloo/parser.rb
+- lib/baloo/version.rb
+- spec/batch_request_spec.rb
+- spec/client_spec.rb
+- spec/convenience_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple Facebook Graph client
+test_files:
+- spec/batch_request_spec.rb
+- spec/client_spec.rb
+- spec/convenience_spec.rb
+- spec/spec_helper.rb