purzelrakete-boomloop 0.0.2

data/History.txt

@@ -0,0 +1,2 @@
+0.0.1, 06.05.2008. 
+* First checkin

data/README.txt

@@ -0,0 +1,36 @@
+This is a Ruby API with which you can access boomloop.com. 
+
+== API Documentation
+
+You can find documentation about the underlying boomloop REST api here: http://boomloop.com/api.
+
+== Getting started
+
+You have to register your api client on boomloop.com before using the api. This is 
+a 3 step process. 
+
+1.  Start by signing up on boomloop.com and register your application. You can do that
+    here: http://boomloop.com/oauth/new. When you have registered your application, you will 
+    receive a consumer key and a consumer secret. 
+
+2.  Setup the api like this: boomloop -k <your consumer key> -s <your consumer secret>
+    You will be given a URL – go there and authorize your application. 
+
+3.  Go back to your terminal window and press <enter>. You're registered :).
+
+== Example API Call
+
+Once you have authorized your client, you can make the first API call like this: 
+
+client =  Boomloop::Authentication::Client.new("api", Boomloop::Authentication::Store::YAMLStore.new)
+connection = client.create_accesstoken
+events = connection.get("/events").body
+
+This returns the raw XML. We'll see how to get Event Objects next. 
+
+The Client takes two arguments - a config key, and an authentication name. When you authorize using
+the boomloop script, a config key 'api' is created in the YAMLStore. This holds your the access
+tokens so that you don't need to negotiate them every time you want to make a request. 
+
+
+

data/bin/boomloop

@@ -0,0 +1,43 @@
+#! /usr/bin/env ruby
+%w(optparse ostruct).each &method(:require)
+require File.dirname(__FILE__) + '/../lib/boomloop'
+
+def error(text); puts text; exit; end
+
+options = OpenStruct.new
+parser = OptionParser.new
+parser.banner = %Q{
+  == Usage
+
+  You have to register your api client on boomloop.com before using the api. This is 
+  a 3 step process. 
+
+  1.  Start by signing up on boomloop.com and register your application. You can do that
+      here: http://boomloop.com/oauth/new. When you have registered your application, you will 
+      receive a consumer key and a consumer secret. 
+
+  2.  Setup the api like this: boomloop -k <your consumer key> -s <your consumer secret>
+      You will be given a URL – go there and authorize your application. 
+
+  3.  Go back to your terminal window and press <enter>. Now do something with the API :).
+  
+}
+
+parser.on_tail("-h", "--help", "Show this message") { error(parser) }
+parser.on("-k", "--key KEY", "Your consumer KEY") { |key| options.key = key }
+parser.on("-s", "--secret SECRET", "Your consumer SECRET") { |secret| options.secret = secret }
+
+# parse.
+parser.parse!(ARGV) rescue error(parser)
+error(parser) unless options.secret && options.key
+
+# negotiate the tokens
+client =  Boomloop::Authentication::Client.new("api", Boomloop::Authentication::Store::YAMLStore.new)
+request_token = client.consume(options.key, options.secret) rescue error("Invalid. Check your credentials at http://boomloop.com/oauth/applications.")
+puts "\nalmost ready! go to #{ request_token.authorize_url }\n\n   press enter when you're done... <waiting>\n"
+
+while !@access_token && gets        
+  @access_token = client.activate rescue nil
+end
+      
+puts "your keys have been activated. you're ready to use the api. \n\n"

data/lib/authentication/client.rb

@@ -0,0 +1,37 @@
+module Boomloop
+  module Authentication
+    class Client
+      attr_accessor :store, :user
+      attr_accessor :consumer, :request_token, :access_token
+      
+      def initialize(user, store)
+        self.user = user
+        self.store = store
+      end
+      
+      def consume(key, secret)
+        self.create_consumer(key, secret)
+        self.request_token = self.consumer.get_request_token
+        self.store.find(user).update(:consumer_key => key, :consumer_secret => secret)
+        self.request_token
+      end
+    
+      def activate
+        if self.request_token
+          self.access_token = self.request_token.get_access_token
+          self.store.find(user).update(:access_key => self.access_token.token, :access_secret => self.access_token.secret)
+        end
+      end
+      
+      def create_consumer(key, secret)
+        self.consumer = OAuth::Consumer.new(key, secret, { :site => "http://boomloop.com" })
+      end
+
+      def create_accesstoken
+        credentials = self.store.find(self.user)
+        self.consumer ||= create_consumer(credentials['consumer_key'], credentials['consumer_secret'])
+        self.access_token ||= OAuth::AccessToken.new(self.consumer, credentials['access_key'], credentials['access_secret'])
+      end
+    end
+  end
+end

data/lib/authentication/credentials.rb

@@ -0,0 +1,29 @@
+module Boomloop
+  module Authentication
+    class Credentials
+      attr_accessor :username, :store, :options
+      
+      def initialize(username, store, options)
+        self.username = username
+        self.store = store
+        self.options = options || {}
+      end
+      
+      def update(tosave)
+        tosave.each do |key, value|
+          self.options[key] = value
+        end
+        
+        save
+      end
+      
+      def save
+        self.store.update(self)
+      end
+      
+      def [](key)
+        self.options[key]
+      end
+    end
+  end
+end

data/lib/authentication/store/base.rb

@@ -0,0 +1,11 @@
+module Boomloop
+  module Authentication
+    module Store
+      class Base
+        def update(credentials)
+          raise NotImplementedError.new("where's me store!")
+        end
+      end
+    end
+  end
+end

data/lib/authentication/store/yaml_store.rb

@@ -0,0 +1,40 @@
+module Boomloop
+  module Authentication
+    module Store      
+      class YAMLStore < Base
+        @@ymlfile = File.dirname(__FILE__) + '/../../../config/credentials.yml'
+        
+        class << self
+          attr_accessor :config
+        end
+
+        def initialize
+          self.class.load_config
+        end
+        
+        def self.load_config
+          File.open(@@ymlfile) do |file|
+            self.config = YAML.load(file) || {}
+          end
+        end
+        
+        def self.save_config
+          if self.config
+            File.open(@@ymlfile, "w") do |f|
+              f.write self.config.to_yaml
+            end
+          end
+        end
+        
+        def update(credentials)
+          self.class.config[credentials.username] = credentials.options
+          self.class.save_config
+        end
+        
+        def find(user)
+          ::Boomloop::Authentication::Credentials.new(user, self, self.class.config[user])
+        end
+      end
+    end
+  end
+end

data/lib/boomloop.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'yaml'
+gem 'oauth'
+require 'oauth/consumer'
+require 'ostruct'
+require 'activesupport'
+
+module Boomloop
+  class ApiError < ::StandardError; end
+end
+
+Dir.glob(File.dirname(__FILE__) + "/**/*.rb").each do |file|
+  require file
+end

data/lib/resources/base.rb

@@ -0,0 +1,84 @@
+module Boomloop
+  module Resources
+    class Base < ::OpenStruct
+      API_BASE = 'http://api.boomloop.com/'
+      
+      class << self
+        attr_accessor :connection
+      end
+      
+      def self.connection
+        @@connection ||= init
+      end
+      
+      # get oauth token
+      def self.init
+        client =  Boomloop::Authentication::Client.new("api", Boomloop::Authentication::Store::YAMLStore.new)
+        self.connection = client.create_accesstoken
+      end
+      
+      def save
+        returned = self.class.create(self)
+        self.instance_variable_set("@table", returned.to_hash)
+        returned
+      end
+      
+      def child_resources
+        links = to_hash.keys.select { |key| key =~ /resource-url$/ }
+      end
+      
+      def to_hash
+        instance_variable_get("@table")
+      end
+      
+      def to_xml
+        self.to_hash.to_xml
+      end
+      
+      def self.singular
+        self.to_s.demodulize.tableize.singularize
+      end
+      
+      def self.plural
+        self.to_s.demodulize.pluralize.tableize
+      end
+      
+      # REST methods
+      def self.index(params = {})
+        url = API_BASE + self.plural
+        url += "?#{ params.to_query }" unless params.empty?
+        xml = connection.get(url)
+        attrs = Hash.from_xml(xml)
+        construct_resource_collection(attrs)
+      end
+      
+      def self.show(url)
+        xml = connection.get(url)
+        attrs = Hash.from_xml(xml)
+        self.new(attrs[self.singular])
+      end
+      
+      def self.create(resource)
+        url = API_BASE + self.plural
+        xml = connection.post(url, resource.to_hash.to_query)
+        self.new(Hash.from_xml(xml)[self.singular])
+      end
+      
+      def self.construct_resource_collection(attrs)
+        collection = attrs[self.plural][self.singular]
+        case collection
+        when Array : collection.map { |hash| self.new(hash) }
+        when Hash : self.new(collection)
+        end
+      end
+      
+      def self.transitive_create(resource)
+        if resource.child_resources
+          child_resources.each { |child| transitive_create(child) }
+        else
+          create(resource)
+        end
+      end
+    end
+  end
+end

data/lib/resources/event.rb

@@ -0,0 +1,6 @@
+module Boomloop
+  module Resources
+    class Event < Base
+    end
+  end
+end

data/lib/resources/event_series.rb

@@ -0,0 +1,6 @@
+module Boomloop
+  module Resources
+    class EventSeries < Base
+    end
+  end
+end

data/lib/resources/place.rb

@@ -0,0 +1,6 @@
+module Boomloop
+  module Resources
+    class Place < Base
+    end
+  end
+end

data/lib/resources/ticket_category.rb

@@ -0,0 +1,6 @@
+module Boomloop
+  module Resources
+    class TicketCategory < Base
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,9 @@
+module Boomloop #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/boomloop_resource_test.rb

@@ -0,0 +1,105 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+context "a boomloop resource" do
+  setup do
+    @connection = Boomloop::Resources::Base.connection
+  end
+  
+  specify "should be creatable by passing in a hash of values" do
+    monster = Boomloop::Resources::Monster.new(:size => :huge, :affect => :sanguine, :name => "fred")
+    monster.affect.should.be :sanguine
+  end
+  
+  specify "should be able to return a hash representation of itself" do
+    qualities = { :size => :huge, :affect => :sanguine, :name => "fred" }
+    monster = Boomloop::Resources::Monster.new(qualities)
+    monster.to_hash.should.equal qualities
+  end
+  
+  specify "should be showable when calling Boomloop::Resources::Monster.show('http://api.boomloop.com/monsters/fred')" do
+    @connection.expects(:get).with("http://api.boomloop.com/monsters/fred").at_least_once.returns(%Q[
+      <monster>
+        <resource_url>http://api.boomloop.com/monsters/fred</resource_url>
+        <size>huge</size>
+        <affect>sanguine</affect>
+        <name>fred</name>
+      </monster>
+    ])
+    
+    monster = Boomloop::Resources::Monster.show('http://api.boomloop.com/monsters/fred')
+    monster.name.should.equal "fred"
+  end
+  
+  specify "should be listable when calling Boomloop::Resources::Monster.index" do
+    @connection.expects(:get).with("http://api.boomloop.com/monsters").at_least_once.returns(%Q[
+      <monsters>
+        <monster>
+          <resource_url>http://api.boomloop.com/monsters/fred</resource_url>
+          <size>huge</size>
+          <affect>sanguine</affect>
+          <name>fred</name>
+        </monster>
+        
+        <monster>
+          <resource_url>http://api.boomloop.com/monsters/simon</resource_url>
+          <size>middling</size>
+          <affect>indifferent</affect>
+          <name>simon</name>
+        </monster>
+      </monsters>
+    ])
+    
+    monsters = Boomloop::Resources::Monster.index
+    monsters.map { |monster| monster.name }.should.include "fred"
+  end
+  
+  specify "should be listable when calling Boomloop::Resources::Monster.index and there is only one result" do
+    @connection.expects(:get).with("http://api.boomloop.com/monsters").at_least_once.returns(%Q[
+      <monsters>
+        <monster>
+          <resource_url>http://api.boomloop.com/monsters/fred</resource_url>
+          <size>huge</size>
+          <affect>sanguine</affect>
+          <name>fred</name>
+        </monster>
+      </monsters>
+    ])
+    
+    monsters = Boomloop::Resources::Monster.index
+    monsters.name.should.equal "fred"
+  end
+
+  specify "should be listable with attributes when calling Boomloop::Resources::Monster.index(:affect => :sanguine)" do
+    @connection.expects(:get).with("http://api.boomloop.com/monsters?affect=sanguine").at_least_once.returns(%Q[
+      <monsters>
+        <monster>
+          <resource_url>http://api.boomloop.com/monsters/fred</resource_url>
+          <size>huge</size>
+          <affect>sanguine</affect>
+          <name>fred</name>
+        </monster>
+      </monsters>
+    ])
+    
+    monsters = Boomloop::Resources::Monster.index(:affect => :sanguine)
+    monsters.name.should.equal "fred"
+  end
+    
+  specify "should be savable when calling .save on a Monster instance" do
+    intended_resource_url = 'http://api.boomloop.com/monsters/samuel'
+    intended_attributes = { :size => :laughable, :affect => :mordant, :name => "samuel" }
+    
+    @connection.expects(:post).with("http://api.boomloop.com/monsters", intended_attributes.to_query).at_least_once.returns(%Q[
+      <monster>
+        <resource_url>#{ intended_resource_url }</resource_url>
+        <size>laughable</size>
+        <affect>mordant</affect>
+        <name>samuel</name>
+      </monster>
+    ])
+    
+    monster = Boomloop::Resources::Monster.new(intended_attributes)
+    monster.save
+    monster.resource_url.should.equal intended_resource_url
+  end
+end

data/test/mocks/monster.rb

@@ -0,0 +1,6 @@
+module Boomloop
+  module Resources
+    class Monster < Base
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/spec'
+require 'mocha'
+
+current_dir = File.dirname(__FILE__)
+
+require current_dir + '/../lib/boomloop'
+require current_dir + '/mocks/monster'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: purzelrakete-boomloop
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Rany Keddo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: boomloop is a kick-ass event platform.
+email: rany@playtype.net
+executables: 
+- boomloop
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+files: 
+- lib/authentication/client.rb
+- lib/authentication/credentials.rb
+- lib/authentication/store/base.rb
+- lib/authentication/store/yaml_store.rb
+- lib/boomloop.rb
+- lib/resources/base.rb
+- lib/resources/event.rb
+- lib/resources/event_series.rb
+- lib/resources/place.rb
+- lib/resources/ticket_category.rb
+- lib/version.rb
+- bin/boomloop
+- History.txt
+- README.txt
+- test/boomloop_resource_test.rb
+- test/mocks
+- test/mocks/monster.rb
+- test/test_helper.rb
+- config/credentials.yml
+has_rdoc: true
+homepage: http://github.com/purzelrakete/boomloop
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Ruby API for boomloop.com
+test_files: []
+