api_object 0.0.1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 TJ Moskun
+
+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,115 @@
+# Initialize an object from an external API
+
+There is a number of external APIs, which provide data over XML or JSON. For example, BART system API http://api.bart.gov/docs/overview/index.aspx. This gem is to designed to load the external API data into a set of nested Ruby objects. 
+
+## Installation
+
+gem install api_object
+
+## Usage
+
+### Example - BART train departure estimate
+
+1) Subclass your objects from ActiveApi::ApiObject
+
+```
+class Station < ActiveApi::ApiObject
+end
+
+class Estimate < ActiveApi::ApiObject
+end
+
+class Station < ActiveApi::ApiObject 
+end
+```
+2) Specify the url to load the data from, optionally a command, an api key and parameters(options) for the url; such as the url would look like "http://\<api_url\>/\<command\>?key=\<api_key\>&\<parameter1=value1&parameter2=value2...\>". 
+
+This will be defined in the upper object over the function "initialize_from_api". Options for this function:
+
+```
+:url - specify url
+
+:command - specify command
+
+:key - api key
+
+:url_options - parameters
+```
+
+
+The following is designed to generate real time departure estimates for BART stations:
+
+```
+class Station
+
+initialize_from_api :url => "http://api.bart.gov/api/", :command => 'etd.aspx', :key => 'MW9S-E7SL-26DU-VV8V', :url_options => {:cmd => 'etd'}
+
+end
+```
+In this example, the url generated to get real time departure estimates from the Richmond station will be:
+http://api.bart.gov/api/etd.aspx?cmd=etd&orig=RICH&key=MW9S-E7SL-26DU-VV8V
+
+3) Define class attributes and mapping of the attributes to the api where the api name is different. To define api simple type mappings, use "api_column \<attribute name\>, \<api attribute name\>". 
+To define api association mapping, use "api_association \<association attribute name\>, \<api attribute name\>, :as => \<association class name\>". Either the second, or the third parameters could be omitted. If the third parameter is omitted, it's mapped to the class name by the attribute name defined in the class. 
+
+In the following example, a simple attribute name is "abbreviation", but the name defined in the api XML documents is "abbr". An association is defined in the attribute :est, the api mapping is :etd and it's an object of the class Estimate. 
+
+```
+class Station < ActiveApi::ApiObject 
+
+initialize_from_api :url => "http://api.bart.gov/api/", :command => 'etd.aspx', :key => 'MW9S-E7SL-26DU-VV8V', :url_options => {:cmd => 'etd'}
+
+attr_reader :name, :abbreviation, :date, :time, :est
+
+api_column :abbreviation, :abbr
+api_association :est, :etd, :as => Estimate
+
+end
+```
+4) To load api data into an object, use the class method "get_results(options)". In the example, get real time estimates for the station Glen Park. 
+
+```
+data = Station.get_results(:orig => 'GLEN')
+```
+
+Please, note that data loaded might be either a hash, or an array of hashes, depending on the api.
+
+5) Create an object from the data
+
+If the example, the data received is a hash, so create an object. 
+
+```
+station = Station.new(data)
+```
+
+If the data is an array of hashes, then it might be used to create an array of objects
+
+```
+stations = data.map {|d| Station.new(d)}
+```
+
+6) Limitations
+
+* Api data must be presented either in XML or in JSON format. The distinction between XML and JSON is determinted automatically. 
+* This is still a very early version and needs more testing. If something is not working, feel free to submit bugs and or/contribute. 
+  
+## Compatibility
+
+Ruby 1.9.3
+
+## License
+
+MIT License. Copyright 2012 TJ Moskun.
+
+
+
+
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+desc 'Run tests'
+    task :test do
+      result = system("ruby -Ilib -Itest -e 'ARGV.each { |f| load f }' test/unit/*")
+      exit(result ? 0 : 1)
+    end
+    
+    task :ci => [:test]
+    task :default => [:test]
+    
+    namespace :pre_commit do
+      desc "run the tests"
+      task :ci => [:test]
+end
+

data/api_object.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "api_object/version"
+
+Gem::Specification.new do |s|
+  s.name        = "api_object"
+  s.version     = ApiObject::VERSION
+  s.authors     = ["tmoskun"]
+  s.email       = ["tanyamoskun@gmail.com"]
+  s.homepage    = "https://github.com/tmoskun/api_object"
+  s.summary     = %q{An interface to load objects from external APIs provided in XML and JSON formats}
+  s.description = %q{An interface to load objects from external APIs provided in XML and JSON formats}
+
+  s.rubyforge_project = "api_object"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  
+  #s.add_development_dependency "sqlite3"
+  s.add_development_dependency "activemodel"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "minitest"
+  s.add_dependency "activesupport"
+  s.add_dependency('nori', '>=1.1')
+  s.add_dependency('rest-client', '>= 1.6')
+  
+end

data/lib/api_object/config_params.rb

@@ -0,0 +1,23 @@
+module ConfigParams
+    
+     IPV4_REGEXP = /\A(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}\z/
+     TIMEOUT = 3
+     FALLBACK_TIMEOUT = 3
+      
+     def timeout
+        TIMEOUT
+     end
+  
+     def timeout= timeout
+        self.TIMEOUT = timeout
+     end
+    
+     def fallback_timeout
+        FALLBACK_TIMEOUT
+     end
+    
+     def fallback_timeout= fallback_timeout
+        self.FALLBACK_TIMEOUT = fallback_timeout
+     end
+        
+end    

data/lib/api_object/query.rb

@@ -0,0 +1,20 @@
+require 'json'
+require 'nori'
+require 'rest-client'
+require_relative 'config_params'
+
+module Query
+   include ConfigParams
+     
+   def  query_api url, command = nil, url_options = {}, options = {} 
+     result = nil
+     cmd_url = url + (command.nil? ? '':"#{command}?")
+     request_url = cmd_url + url_options.to_a.map{|opt| opt[0].to_s + "=" + opt[1]}.join("&")
+     Timeout.timeout(self.fallback_timeout) do
+       result_raw = RestClient::Request.execute(:method => :get, :url => request_url, :timeout => self.timeout)
+       result = result_raw.start_with?('<?xml') ? Nori.parse(result_raw) : JSON.parse(result_raw)
+     end
+     result
+   end
+             
+end

data/lib/api_object/version.rb

@@ -0,0 +1,3 @@
+module ApiObject
+  VERSION = "0.0.1"
+end

data/lib/api_object.rb

@@ -0,0 +1,95 @@
+require "api_object/version"
+require "api_object/query"
+require "active_support/all"
+
+module ActiveApi
+       
+    module ClassMethods 
+      
+      def self.extended(base)
+        base.send(:extend, Query)     
+      end
+              
+      def initialize_from_api options = {}
+          class_attribute :url, :command, :key, :url_options, :object_name
+          self.url, self.command, self.key, self.url_options, self.object_name = [options[:url], options[:command], options[:key], (options[:url_options] || {}), (options[:object_name] || self.to_s.downcase.gsub(/^(.+::)(.+)$/, '\2'))]
+      end
+            
+      def get_results options = {}
+          self.url_options.merge!(:key => self.key) unless self.key.nil?
+          result = query_api(self.url, self.command, self.url_options.merge(options))
+          other_keys = {}
+          unless result.nil? 
+            until result.keys.include?(self.object_name.to_s)
+               result = result[result.keys[0]]
+               return nil if (result.nil? || result.empty? || result.instance_of?(Array)) 
+               other_keys.merge!(result.keys.inject({}) { |h, k| (self.method_defined?(k) ? h.merge(k => result[k]) : h)})    
+            end
+          end
+          other_keys.merge(result[self.object_name.to_s])
+      end
+      
+   end
+   
+   module InstanceMethods
+            
+      def initialize(*args)
+          args.first.each do |k, v| 
+             unless defined?(k).nil?    # check if it's included as a reader attribute
+                k = self.columns[k.to_sym] unless self.columns[k.to_sym].nil?
+                klass = self.assoc[k.to_sym] || k
+                result = v.instance_of?(Array) ? v.inject([]) {|arr, v1| arr << init_object(v1, klass)} : init_object(v, klass)
+                instance_variable_set("@#{k.to_s}", result)
+             end
+          end if (args.length == 1 && args.first.is_a?(Hash)) 
+      end
+            
+            
+      def persisted?
+          false
+      end
+      
+       
+    private    
+                      
+      def init_object value, klass
+          if value.instance_of?(Hash)
+            klass = (get_module_name + klass.to_s.capitalize).constantize unless klass.class == Class
+            klass.new(value)
+          else
+            value
+          end
+      end
+      
+      def get_module_name
+          (self.class.name =~ /^(.+::).+$/) ? $1 : ''
+      end
+            
+    end
+    
+    module SingletonMethods
+      def api_column column_name, api_name
+         self.columns.merge!(api_name => column_name)
+      end
+           
+      def api_association (*args)
+         options = args.extract_options!
+         self.columns.merge!(args[1] => args[0]) if args.length >= 2
+         self.assoc.merge!(args[0] => options[:as]) unless options[:as].nil? 
+      end     
+         
+    end 
+    
+    class ApiObject
+        extend ClassMethods
+        include InstanceMethods
+        extend SingletonMethods
+                    
+       class_attribute :columns, :assoc 
+       self.columns, self.assoc = [{}, {}]
+       
+    end
+    
+      
+  end
+             

data/test/data/estimate/glen.xml

@@ -0,0 +1,251 @@
+<root>
+	<uri>
+		<![CDATA[ http://api.bart.gov/api/etd.aspx?cmd=etd&orig=GLEN ]]>
+	</uri>
+	<date>03/29/2012</date>
+	<time>06:02:01 PM PDT</time>
+	<station>
+		<name>Glen Park</name>
+		<abbr>GLEN</abbr>
+		<etd>
+			<destination>Daly City</destination>
+			<abbreviation>DALY</abbreviation>
+			<estimate>
+				<minutes>3</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>10</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>17</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Dublin/Pleasanton</destination>
+			<abbreviation>DUBL</abbreviation>
+			<estimate>
+				<minutes>11</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>27</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>41</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Fremont</destination>
+			<abbreviation>FRMT</abbreviation>
+			<estimate>
+				<minutes>4</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>18</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>33</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Millbrae</destination>
+			<abbreviation>MLBR</abbreviation>
+			<estimate>
+				<minutes>6</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>15</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>8</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>28</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+				</estimate>
+			</etd>
+		<etd>
+			<destination>Pittsburg/Bay Point</destination>
+			<abbreviation>PITT</abbreviation>
+			<estimate>
+				<minutes>13</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>28</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>43</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Richmond</destination>
+			<abbreviation>RICH</abbreviation>
+			<estimate>
+				<minutes>13</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>25</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>37</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+				</estimate>
+			</etd>
+		<etd>
+			<destination>SF Airport</destination>
+			<abbreviation>SFIA</abbreviation>
+			<estimate>
+				<minutes>8</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>21</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>SFO/Millbrae</destination>
+			<abbreviation>MLBR</abbreviation>
+			<estimate>
+				<minutes>35</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>50</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>65</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+	</station>
+	<message/>
+</root>

data/test/data/estimate/sixteenth.xml

@@ -0,0 +1,246 @@
+<root>
+	<uri>
+	<![CDATA[ http://api.bart.gov/api/etd.aspx?cmd=etd&orig=16TH ]]>
+	</uri>
+	<date>03/29/2012</date>
+	<time>06:08:30 PM PDT</time>
+	<station>
+		<name>16th St. Mission</name>
+		<abbr>16TH</abbr>
+		<etd>
+			<destination>24th Street</destination>
+			<abbreviation>24TH</abbreviation>
+			<estimate>
+				<minutes>2</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Daly City</destination>
+			<abbreviation>DALY</abbreviation>
+			<estimate>
+				<minutes>Leaving</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>6</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>13</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Dublin/Pleasanton</destination>
+			<abbreviation>DUBL</abbreviation>
+			<estimate>
+				<minutes>10</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>24</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>39</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Fremont</destination>
+			<abbreviation>FRMT</abbreviation>
+			<estimate>
+				<minutes>3</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>16</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>31</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Millbrae</destination>
+			<abbreviation>MLBR</abbreviation>
+			<estimate>
+				<minutes>4</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>8</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>18</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Pittsburg/Bay Point</destination>
+			<abbreviation>PITT</abbreviation>
+			<estimate>
+				<minutes>6</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>12</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>28</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Richmond</destination>
+			<abbreviation>RICH</abbreviation>
+			<estimate>
+				<minutes>11</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>20</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>35</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>SF Airport</destination>
+			<abbreviation>SFIA</abbreviation>
+			<estimate>
+				<minutes>9</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>SFO/Millbrae</destination>
+			<abbreviation>MLBR</abbreviation>
+			<estimate>
+				<minutes>24</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>39</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>54</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+	</station>
+	<message/>
+</root>

data/test/data/estimate/twenty_fourth.xml

@@ -0,0 +1,233 @@
+<root>
+	<uri>
+	<![CDATA[ http://api.bart.gov/api/etd.aspx?cmd=etd&orig=24TH ]]>
+	</uri>
+	<date>03/29/2012</date>
+	<time>06:09:02 PM PDT</time>
+	<station>
+		<name>24th St. Mission</name>
+		<abbr>24TH</abbr>
+		<etd>
+			<destination>Daly City</destination>
+			<abbreviation>DALY</abbreviation>
+			<estimate>
+				<minutes>2</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>8</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>15</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>0</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Dublin/Pleasanton</destination>
+			<abbreviation>DUBL</abbreviation>
+			<estimate>
+				<minutes>8</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>22</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>37</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>BLUE</color>
+				<hexcolor>#0099cc</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Fremont</destination>
+			<abbreviation>FRMT</abbreviation>
+			<estimate>
+				<minutes>14</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>29</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>44</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>8</length>
+				<color>GREEN</color>
+				<hexcolor>#339933</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Millbrae</destination>
+			<abbreviation>MLBR</abbreviation>
+			<estimate>
+				<minutes>5</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>8</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>19</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Pittsburg/Bay Point</destination>
+			<abbreviation>PITT</abbreviation>
+			<estimate>
+				<minutes>4</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+			<minutes>9</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>26</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>Richmond</destination>
+			<abbreviation>RICH</abbreviation>
+			<estimate>
+				<minutes>8</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>18</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>33</minutes>
+				<platform>2</platform>
+				<direction>North</direction>
+				<length>10</length>
+				<color>RED</color>
+				<hexcolor>#ff0000</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>SF Airport</destination>
+			<abbreviation>SFIA</abbreviation>
+			<estimate>
+				<minutes>11</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+		<etd>
+			<destination>SFO/Millbrae</destination>
+			<abbreviation>MLBR</abbreviation>
+			<estimate>
+				<minutes>25</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>10</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>40</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+			<estimate>
+				<minutes>55</minutes>
+				<platform>1</platform>
+				<direction>South</direction>
+				<length>9</length>
+				<color>YELLOW</color>
+				<hexcolor>#ffff33</hexcolor>
+				<bikeflag>1</bikeflag>
+			</estimate>
+		</etd>
+	</station>
+	<message/>
+</root>

data/test/unit/api_object_test.rb

@@ -0,0 +1,42 @@
+require 'minitest/autorun'
+require_relative 'station'
+
+class ApiObjectTest < MiniTest::Unit::TestCase
+  
+  include ActiveApi
+  include TestObjects
+
+  @@data_directory = File.expand_path('../../data', __FILE__)
+  @@estimate_directory = @@data_directory + "/estimate"
+   
+  @@glen_estimate = Station.load_from_xml(File.read(@@estimate_directory + '/glen.xml'))    
+  @@sixteenth_estimate = Station.load_from_xml(File.read(@@estimate_directory + '/sixteenth.xml'))
+  @@twenty_fourth_estimate = Station.load_from_xml(File.read(@@estimate_directory + '/twenty_fourth.xml'))
+    
+  def test_should_get_correct_estimates
+    glen_estimate = Station.new(Station.get_results(:orig => 'GLEN'))
+    now = DateTime.strptime(glen_estimate.date + " " + glen_estimate.time, "%m/%d/%Y %I:%M:%S %p %Z") 
+    if business_time? now
+      sixteenth_estimate = Station.new(Station.get_results(:orig => '16TH'))
+      twenty_fourth_estimate = Station.new(Station.get_results(:orig => '24TH'))
+      assert_equal(glen_estimate, @@glen_estimate)
+      assert_equal(sixteenth_estimate, @@sixteenth_estimate)
+      assert_equal(twenty_fourth_estimate, @@twenty_fourth_estimate)
+    end
+  end
+  
+    
+private 
+  def business_time? now
+    unless now.to_date.sunday? 
+         #t = now.to_time.localtime(now.zone)
+         #t1 = DateTime.strptime("#{now.month}/#{now.day}/#{now.year} 10:00:00 AM #{now.zone}", "%m/%d/%Y %I:%M:%S %p %:z").to_time.localtime(now.zone)
+         #t2 = DateTime.strptime("#{now.month}/#{now.day}/#{now.year} 08:00:00 PM #{now.zone}", "%m/%d/%Y %I:%M:%S %p %:z").to_time.localtime(now.zone)
+         t1 = DateTime.strptime("#{now.month}/#{now.day}/#{now.year} 10:00:00 AM #{now.zone}", "%m/%d/%Y %I:%M:%S %p %:z")
+         t2 = DateTime.strptime("#{now.month}/#{now.day}/#{now.year} 08:00:00 PM #{now.zone}", "%m/%d/%Y %I:%M:%S %p %:z")
+         return now > t1 && now < t2
+    end
+    return false
+  end
+  
+end

data/test/unit/load_from_xml.rb

@@ -0,0 +1,10 @@
+module LoadFromXML
+   def load_from_xml xml
+       hash = Nori.parse(xml)
+       hash = hash["root"] if hash.keys.include?("root")
+       timestamp = hash["date"].nil? ? {} : {"date" => hash["date"], "time" => hash["time"]}
+       hash = hash["stations"] if hash.keys.include?("stations")
+       hash = hash["station"] if hash.keys.include?("station")
+       new(timestamp.merge(hash))
+   end
+end

data/test/unit/station.rb

@@ -0,0 +1,67 @@
+require 'api_object'
+require_relative 'load_from_xml'
+module TestObjects
+  
+  module StationMethods
+     def to_s
+       inspect
+     end
+      
+  end
+  
+  class Departure < ActiveApi::ApiObject
+      include StationMethods
+      attr_reader :minutes, :platform, :direction, :length, :color, :bikes_allowed
+      
+      api_column :bikes_allowed, :bikeflag
+   
+      def inspect
+         "#{@platform} platform - #{@minutes}#{(@minutes == 'Leaving') ? '':' minutes'}"
+      end
+  
+      def ==(other_)
+        true
+      end
+      
+  end
+  
+  class Estimate < ActiveApi::ApiObject
+      include StationMethods
+      attr_reader :abbreviation, :destination, :estimate
+      
+      api_association :estimate, :as => Departure
+     
+      def inspect
+         "destination #{@destination} \n\t\t #{@estimate.inspect}"
+      end
+      
+      def ==(other_est)
+        return false if other_est.nil?  
+        self.abbreviation == other_est.abbreviation && self.destination == other_est.destination
+      end
+      
+  end
+  
+  class Station < ActiveApi::ApiObject 
+      extend LoadFromXML
+      include StationMethods
+      
+      attr_reader :name, :abbreviation, :date, :time, :est
+        
+      initialize_from_api :url => "http://api.bart.gov/api/", :command => 'etd.aspx', :key => 'MW9S-E7SL-26DU-VV8V', :url_options => {:cmd => 'etd'}
+         
+      api_column :abbreviation, :abbr
+      api_association :est, :etd, :as => TestObjects::Estimate
+      
+      def inspect
+         "#{@name} at #{@date}, #{@time} \n\t #{@est.instance_of?(Array) ? (@est.inject('') {|str, e| (str + e.inspect + "\n\t")}) : @est}"
+      end
+      
+      def ==(other_station)
+        return false if other_station.nil?
+        self.abbreviation == other_station.abbreviation && self.est == other_station.est
+      end
+               
+    end
+    
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: api_object
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- tmoskun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &71094620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *71094620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70815040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70815040
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70814760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70814760
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70814480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70814480
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: &70814230 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70814230
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70813950 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70813950
+description: An interface to load objects from external APIs provided in XML and JSON
+  formats
+email:
+- tanyamoskun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- api_object.gemspec
+- lib/api_object.rb
+- lib/api_object/config_params.rb
+- lib/api_object/query.rb
+- lib/api_object/version.rb
+- test/data/estimate/glen.xml
+- test/data/estimate/sixteenth.xml
+- test/data/estimate/twenty_fourth.xml
+- test/unit/api_object_test.rb
+- test/unit/load_from_xml.rb
+- test/unit/station.rb
+homepage: https://github.com/tmoskun/api_object
+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: api_object
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: An interface to load objects from external APIs provided in XML and JSON
+  formats
+test_files: []