purzelrakete-boomloop 0.0.2 → 0.0.3

data/README.txt

@@ -20,17 +20,14 @@ a 3 step process.
 
 == Example API Call
 
-Once you have authorized your client, you can make the first API call like this: 
+Once you have authorized your client, you can make the first API client call. 
 
-client =  Boomloop::Authentication::Client.new("api", Boomloop::Authentication::Store::YAMLStore.new)
-connection = client.create_accesstoken
-events = connection.get("/events").body
+require 'boomloop'
+events = Boomloop::Resources::Event.index(:order => :proximity, :origin => "opernplatz, frankfurt am main")
 
-This returns the raw XML. We'll see how to get Event Objects next. 
+This returns a list of the top 10 closest upcoming events, where the origin is opernplatz, frankfurt am main. 
 
-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. 
+For a full description of options, see boomloop.com/api. The ruby lib is just a thin wrapper around the REST api, so what goes up rthere, must come down here ;)
 
 
 

data/bin/boomloop

@@ -33,11 +33,11 @@ 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.")
+request_token = client.consume(options.key, options.secret) rescue error("Invalid. Check your credentials at #{ Boomloop::Resources::Base.api_base }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"
+puts "your keys have been activated. you're ready to use the api. \n\n"

data/lib/authentication/client.rb

@@ -1,3 +1,8 @@
+=begin
+  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. 
+=end
 module Boomloop
   module Authentication
     class Client

data/lib/resources/base.rb

@@ -1,12 +1,14 @@
 module Boomloop
   module Resources
     class Base < ::OpenStruct
-      API_BASE = 'http://api.boomloop.com/'
-      
       class << self
         attr_accessor :connection
       end
       
+      def self.api_base
+        ENV["BOOMLOOP_API_BASE"] || 'http://api.boomloop.com/'
+      end
+      
       def self.connection
         @@connection ||= init
       end
@@ -45,23 +47,37 @@ module Boomloop
       
       # REST methods
       def self.index(params = {})
-        url = API_BASE + self.plural
+        url = api_base + self.plural
         url += "?#{ params.to_query }" unless params.empty?
         xml = connection.get(url)
-        attrs = Hash.from_xml(xml)
+        
+        attrs = from_xml(xml)
         construct_resource_collection(attrs)
       end
       
       def self.show(url)
         xml = connection.get(url)
-        attrs = Hash.from_xml(xml)
+        attrs = from_xml(xml)
         self.new(attrs[self.singular])
       end
       
       def self.create(resource)
-        url = API_BASE + self.plural
+        url = api_base + self.plural
         xml = connection.post(url, resource.to_hash.to_query)
-        self.new(Hash.from_xml(xml)[self.singular])
+        self.new(from_xml(xml)[self.singular])
+      end
+      
+      def self.from_xml(response)
+        xml = nil
+        begin
+          xml = Hash.from_xml(response)
+        rescue Exception => e
+          raise Boomloop::APIError.new("Response from boomloop could not be parsed. Response was: \n\n #{ response }")
+        end
+        
+        raise Boomloop::APIError.new("There was a problem with your request: \n\n #{ response }") if xml["errors"]
+
+        xml
       end
       
       def self.construct_resource_collection(attrs)

data/test/boomloop_resource_test.rb

@@ -16,32 +16,32 @@ context "a boomloop resource" do
     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[
+  specify "should be showable when calling Boomloop::Resources::Monster.show('#{ Boomloop::Resources::Base.api_base }monsters/fred')" do
+    @connection.expects(:get).with("#{ Boomloop::Resources::Base.api_base }monsters/fred").at_least_once.returns(%Q[
       <monster>
-        <resource_url>http://api.boomloop.com/monsters/fred</resource_url>
+        <resource_url>#{ Boomloop::Resources::Base.api_base }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 = Boomloop::Resources::Monster.show("#{ Boomloop::Resources::Base.api_base }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[
+    @connection.expects(:get).with("#{ Boomloop::Resources::Base.api_base }monsters").at_least_once.returns(%Q[
       <monsters>
         <monster>
-          <resource_url>http://api.boomloop.com/monsters/fred</resource_url>
+          <resource_url>#{ Boomloop::Resources::Base.api_base }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>
+          <resource_url>#{ Boomloop::Resources::Base.api_base }monsters/simon</resource_url>
           <size>middling</size>
           <affect>indifferent</affect>
           <name>simon</name>
@@ -54,10 +54,10 @@ context "a boomloop resource" do
   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[
+    @connection.expects(:get).with("#{ Boomloop::Resources::Base.api_base }monsters").at_least_once.returns(%Q[
       <monsters>
         <monster>
-          <resource_url>http://api.boomloop.com/monsters/fred</resource_url>
+          <resource_url>#{ Boomloop::Resources::Base.api_base }monsters/fred</resource_url>
           <size>huge</size>
           <affect>sanguine</affect>
           <name>fred</name>
@@ -70,10 +70,10 @@ context "a boomloop resource" do
   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[
+    @connection.expects(:get).with("#{ Boomloop::Resources::Base.api_base }monsters?affect=sanguine").at_least_once.returns(%Q[
       <monsters>
         <monster>
-          <resource_url>http://api.boomloop.com/monsters/fred</resource_url>
+          <resource_url>#{ Boomloop::Resources::Base.api_base }monsters/fred</resource_url>
           <size>huge</size>
           <affect>sanguine</affect>
           <name>fred</name>
@@ -86,10 +86,10 @@ context "a boomloop resource" do
   end
     
   specify "should be savable when calling .save on a Monster instance" do
-    intended_resource_url = 'http://api.boomloop.com/monsters/samuel'
+    intended_resource_url = "#{ Boomloop::Resources::Base.api_base }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[
+    @connection.expects(:post).with("#{ Boomloop::Resources::Base.api_base }monsters", intended_attributes.to_query).at_least_once.returns(%Q[
       <monster>
         <resource_url>#{ intended_resource_url }</resource_url>
         <size>laughable</size>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: purzelrakete-boomloop
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Rany Keddo