vigetlabs-radarb 1.1.0

data/History.txt

@@ -0,0 +1,9 @@
+== 1.1.0 / 2008-1-15
+
+* Refactored internals to use gotascii-happymapper.
+* Updated README to reflect API changes due to the happymapper refactoring.
+
+== 1.0.0 / 2008-12-16
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/radarb.rb
+lib/radarb/collectable.rb
+lib/radarb/fetch.rb
+lib/radarb/place.rb
+lib/radarb/radar.rb
+lib/radarb/tag.rb
+radarb.gemspec
+test/radarb/collectable_test.rb
+test/radarb/radar_test.rb
+test/radarb_test.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,75 @@
+radarb
+  by Justin Marney
+  http://github.com/vigetlabs/radarb
+
+== DESCRIPTION:
+
+A ruby gem that makes using the http://outside.in/ API simple.
+
+== SYNOPSIS:
+
+require 'radarb'
+
+blips = Radarb::Radar.scan('40.714550', '-74.007124')
+
+blips.each do |blip|
+  puts blip.author
+  puts blip.url
+  puts blip.type
+end
+
+blips.stories.each do |story|
+  puts story.title
+  puts story.body
+end
+
+blips.tweets.each do |story|
+  puts story.author
+  puts story.body
+end
+
+story = blips.stories.first
+
+story.places.each do |place|
+  puts place.name
+  puts place.url
+end
+
+story.tags.each do |tag|
+  puts tag.name
+  puts tag.url
+end
+
+== REQUIREMENTS:
+
+sudo gem install curb
+sudo gem install gotascii-happymapper -s http://gems.github.com
+
+== INSTALL:
+
+sudo gem install vigetlabs-radarb -s http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME (different 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/Rakefile

@@ -0,0 +1,26 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  load 'tasks/setup.rb'
+end
+
+ensure_in_path 'lib'
+require 'radarb'
+
+task :default => 'test'
+
+PROJ.name = 'radarb'
+PROJ.authors = 'Justin Marney'
+PROJ.email = 'justin.marney@viget.com'
+PROJ.url = 'http://github.com/vigetlabs/radarb'
+PROJ.version = Radarb::VERSION
+PROJ.rubyforge.name = 'radarb'
+PROJ.test.files = FileList['test/**/*_test.rb']
+PROJ.spec.opts << '--color'
+
+# EOF

data/lib/radarb/collectable.rb

@@ -0,0 +1,15 @@
+module Radarb
+  module Collectable
+    def tweets
+      find_by_type('Tweet')
+    end
+
+    def stories
+      find_by_type('Story')
+    end
+
+    def find_by_type(type)
+      select{|item| item.type == type }
+    end
+  end
+end

data/lib/radarb/fetch.rb

@@ -0,0 +1,7 @@
+module Radarb
+  module Fetch
+    def self.fetch_url(url)
+      Curl::Easy.perform(url).body_str
+    end
+  end
+end

data/lib/radarb/place.rb

@@ -0,0 +1,10 @@
+module Radarb
+  class Place
+    include HappyMapper
+
+    tag 'place'
+    element :id, Integer
+    element :name, String
+    element :url, String
+  end
+end

data/lib/radarb/radar.rb

@@ -0,0 +1,23 @@
+module Radarb
+  class Radar
+    include HappyMapper
+
+    tag 'radar'
+    element :item_id, Integer
+    element :icon_path, String
+    element :author, String
+    element :author_url, String
+    element :published_at, DateTime
+    element :title, String
+    element :body, String
+    element :url, String
+    element :image_url, String
+    attribute :type, String
+
+    def self.scan(lat = '40.755970', lng='-73.986702')
+      url = "#{API}?lat=#{lat}&lng=#{lng}"
+      xml = Fetch::fetch_url(url)
+      parse(xml).extend(Collectable)
+    end
+  end
+end

data/lib/radarb/tag.rb

@@ -0,0 +1,9 @@
+module Radarb
+  class Tag
+    include HappyMapper
+
+    tag 'tag'
+    element :name, String
+    element :url, String
+  end
+end

data/lib/radarb.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'curb'
+require 'happymapper'
+
+module Radarb
+
+  API = "http://api.outside.in/radar.xml"
+
+  # :stopdoc:
+  VERSION = '1.1.0'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to rquire all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '*', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module Radarb
+
+require 'radarb/fetch'
+require 'radarb/collectable'
+require 'radarb/tag'
+require 'radarb/place'
+require 'radarb/radar'
+
+# EOF

data/radarb.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name     = "radarb"
+  s.version  = "1.1.0"
+  s.date     = "2008-01-15"
+  s.summary  = "outside.in radar API wrapper."
+  s.email    = "justin.marney@viget.com"
+  s.homepage = "http://github.com/vigetlabs/radarb"
+  s.description = "A ruby gem that makes using the http://outside.in/ API simple."
+  s.has_rdoc = true
+  s.authors  = ["Justin Marney"]
+  s.files    = ["History.txt", 
+		"README.txt",
+		"Rakefile",
+		"radarb.gemspec",
+		"lib/radarb.rb",
+		"lib/radarb/collectable.rb",
+		"lib/radarb/fetch.rb",
+		"lib/radarb/place.rb",
+		"lib/radarb/radar.rb",
+		"lib/radarb/tag.rb"]
+  s.test_files = ["test/test_helper.rb", 
+      "test/radarb_test.rb",
+      "test/radarb/radar_test.rb",
+      "test/radarb/collectable_test.rb"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.add_dependency("gotascii-happymapper", ["> 0.0.0"])
+  s.add_dependency("curb", ["> 0.0.0"])
+end

data/test/radarb/collectable_test.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+module Radarb
+  class ColelctableTest < Test::Unit::TestCase
+    context "An object extended by the Collectable module" do
+      setup do
+        @collectable = [].extend(Collectable)
+      end
+      
+      should "return all items with type Tweet" do
+        @collectable.expects(:find_by_type).with('Tweet').returns('tweet!')
+        assert_equal 'tweet!', @collectable.tweets
+      end
+
+      should "return all items with type Story" do
+        @collectable.expects(:find_by_type).with('Story').returns('story!')
+        assert_equal 'story!', @collectable.stories
+      end
+
+      should "return all items with specified type" do
+        tweet = stub(:type => 'Tweet')
+        story = stub(:type => 'Story')
+        @collectable << tweet
+        @collectable << story
+        @collectable.find_by_type('Tweet')
+        assert_equal [tweet], @collectable.find_by_type('Tweet')
+      end
+    end
+  end
+end

data/test/radarb/radar_test.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+module Radarb
+  class RadarTest < Test::Unit::TestCase
+    context "The Radar class" do
+      should "make the api call and fetch the response xml when created" do
+        Radar.stubs(:parse)
+        Fetch.expects(:fetch_url).with("#{API}?lat=123&lng=456")
+        Radar.scan('123', '456')
+      end
+
+      should "parse the api xml response" do
+        Fetch.stubs(:fetch_url).returns('xml')
+        Radar.expects(:parse).with('xml').returns('parsed_xml')
+        assert_equal 'parsed_xml', Radar.scan('123', '456')
+      end
+
+      should "extend the parsed xml with Collectable" do
+        Fetch.stubs(:fetch_url).returns('xml')
+        parsed_xml = mock {|m| m.expects(:extend).with(Collectable) }
+        Radar.stubs(:parse).with('xml').returns(parsed_xml)
+        Radar.scan('123', '456')
+      end
+    end
+  end
+end

data/test/radarb_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class RadarbTest < Test::Unit::TestCase
+  context "A green egg" do
+    should "be served with ham" do
+      assert true
+    end
+  end  
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require 'shoulda'
+require 'radarb'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: vigetlabs-radarb
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Justin Marney
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gotascii-happymapper
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: curb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: A ruby gem that makes using the http://outside.in/ API simple.
+email: justin.marney@viget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- README.txt
+- Rakefile
+- radarb.gemspec
+- lib/radarb.rb
+- lib/radarb/collectable.rb
+- lib/radarb/fetch.rb
+- lib/radarb/place.rb
+- lib/radarb/radar.rb
+- lib/radarb/tag.rb
+- Manifest.txt
+has_rdoc: true
+homepage: http://github.com/vigetlabs/radarb
+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.2.0
+signing_key: 
+specification_version: 2
+summary: outside.in radar API wrapper.
+test_files: 
+- test/test_helper.rb
+- test/radarb_test.rb
+- test/radarb/radar_test.rb
+- test/radarb/collectable_test.rb