reagent-fleakr 0.1.0

data/README.markdown

@@ -0,0 +1,38 @@
+# Fleakr
+
+## Description
+
+A teeny tiny gem to interface with Flickr photostreams
+
+## Installation
+
+    sudo gem install fleakr
+
+## Usage
+
+    require 'fleakr'
+
+## License
+
+Copyright (c) 2008 Patrick Reagan (reaganpr@gmail.com)
+
+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,39 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/fleakr/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'fleakr'
+  s.version          = Fleakr::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.markdown)
+  s.summary          = "A teeny tiny gem to interface with Flickr photostreams"
+  s.author           = 'Patrick Reagan'
+  s.email            = 'reaganpr@gmail.com'
+  s.homepage         = 'http://sneaq.net'
+  s.files            = %w(README.markdown Rakefile) + Dir.glob("{lib,test}/**/*")
+  # s.executables    = ['fleakr']
+  
+  s.add_dependency('hpricot', '~> 0.6.0')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/fleakr.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'uri'
+require 'net/http'
+require 'hpricot'
+
+Dir.glob(File.dirname(__FILE__) + '/**/*').each {|f| require f }

data/lib/fleakr/request.rb

@@ -0,0 +1,34 @@
+module Fleakr
+  class Request
+
+    def self.api_key=(key)
+      @api_key = key
+    end
+    
+    def self.api_key
+      @api_key
+    end
+    
+    def endpoint_uri
+      uri = URI.parse('http://api.flickr.com/services/rest/')
+      uri.query = self.query_parameters
+      uri
+    end
+    
+    def query_parameters
+      @parameters.map {|key,value| "#{key}=#{value}" }.join('&')
+    end
+    
+    def initialize(method, additional_parameters = {})
+      method = method.sub(/^(flickr\.)?/, 'flickr.')
+      
+      default_parameters = {:api_key => self.class.api_key, :method => method}
+      @parameters = default_parameters.merge(additional_parameters)
+    end
+    
+    def send
+      Response.new(Net::HTTP.get(self.endpoint_uri))
+    end
+    
+  end
+end

data/lib/fleakr/response.rb

@@ -0,0 +1,17 @@
+module Fleakr
+  class Response
+    
+    def initialize(response_xml)
+      @response_xml = response_xml
+    end
+
+    def body
+      @body ||= Hpricot.XML(@response_xml)
+    end
+    
+    def error?
+      (self.body/'rsp').attr('stat') != 'ok'
+    end
+    
+  end
+end

data/lib/fleakr/set.rb

@@ -0,0 +1,19 @@
+module Fleakr
+  class Set
+    
+    attr_accessor :title, :description
+    
+    def self.find_all_by_user_id(user_id)
+      response = Request.new('photosets.getList', :user_id => user_id).send
+      
+      (response.body/'photosets/photoset').map do |flickr_set|
+        set = Set.new
+        set.title = (flickr_set/'title').inner_text
+        set.description = (flickr_set/'description').inner_text
+        set
+      end
+
+    end
+    
+  end
+end

data/lib/fleakr/user.rb

@@ -0,0 +1,21 @@
+module Fleakr
+  class User
+    
+    attr_accessor :id, :username
+    
+    def self.find_by_username(username)
+      response = Fleakr::Request.new('people.findByUsername', :username => username).send
+      
+      user = User.new
+      user.id = (response.body/'rsp/user').attr('id')
+      user.username = (response.body/'rsp/user/username').inner_text
+      
+      user
+    end
+    
+    def sets
+      @set ||= Set.find_all_by_user_id(self.id)
+    end
+    
+  end
+end

data/lib/fleakr/version.rb

@@ -0,0 +1,13 @@
+module Fleakr
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/test/fixtures/people.findByUsername.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<rsp stat="ok">
+  <user id="31066442@N69" nsid="31066442@N69">
+    <username>frootpantz</username>
+  </user>
+</rsp>

data/test/fixtures/photosets.getList.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="ok">
+<photosets>
+	<photoset videos="0" primary="3044180117" farm="4" photos="138" id="72157609490909659" server="3012" secret="01cd1a741d">
+		<title>Second Set</title>
+		<description>This is the second set.</description>
+	</photoset>
+	<photoset videos="0" primary="2988511085" farm="4" photos="139" id="72157608538140671" server="3241" secret="a7b90926ba">
+		<title>First Set</title>
+		<description>This is the first set.</description>
+	</photoset>
+</photosets>
+</rsp>

data/test/fleakr/request_test.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class RequestTest < Test::Unit::TestCase
+
+    describe "A Request instance" do
+
+      it "should be able to set an API key" do
+        key = 'f00b4r'
+        Request.api_key = key
+        key.should == Request.api_key
+      end
+      
+      context "with an API key" do
+
+        before do
+          @api_key = 'f00b4r'
+          Request.stubs(:api_key).with().returns(@api_key)
+        end
+        
+        it "should know the full query parameters" do
+          request = Request.new('flickr.people.findByUsername', :username => 'foobar')
+          
+          expected = [
+            "api_key=#{@api_key}",
+            "method=flickr.people.findByUsername",
+            "username=foobar"
+          ]
+          
+          request.query_parameters.split('&').sort.should == expected
+        end
+        
+        it "should translate a shorthand API call" do
+          request = Request.new('people.findByUsername')
+          request.query_parameters.split('&').include?('method=flickr.people.findByUsername').should be(true)
+        end
+        
+        it "should know the endpoint with full parameters" do
+          query_parameters = 'foo=bar'
+          
+          request = Request.new('people.getInfo')
+          request.stubs(:query_parameters).with().returns(query_parameters)
+          
+          uri_mock = mock() {|m| m.expects(:query=).with(query_parameters)}
+          
+          URI.expects(:parse).with("http://api.flickr.com/services/rest/").returns(uri_mock)
+          
+          request.endpoint_uri.should == uri_mock
+        end
+        
+        it "should be able to make a request" do
+          endpoint_uri = stub()
+        
+          request = Request.new('flickr.people.findByUsername')
+          
+          request.stubs(:endpoint_uri).with().returns(endpoint_uri)
+          Net::HTTP.expects(:get).with(endpoint_uri).returns('<xml>')
+          
+          request.send
+        end
+        
+        it "should create a response from the request" do
+          response_xml  = '<xml>'
+          response_stub = stub()
+          
+          request = Request.new('flickr.people.findByUsername')
+          
+          Net::HTTP.stubs(:get).returns(response_xml)
+          Response.expects(:new).with(response_xml).returns(response_stub)
+          
+          request.send.should == response_stub
+        end
+        
+      end
+
+    end
+  end
+end

data/test/fleakr/response_test.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class ResponseTest < Test::Unit::TestCase
+
+    describe "An instance of Response" do
+
+      it "should provide the response body as an Hpricot element" do
+        response_xml = '<xml>'
+        hpricot_stub = stub()
+
+        Hpricot.expects(:XML).with(response_xml).returns(hpricot_stub)
+        
+        response = Response.new(response_xml)
+        response.body.should == hpricot_stub
+      end
+      
+      it "should memoize the Hpricot document" do
+        response = Response.new('<xml>')
+        
+        Hpricot.expects(:XML).with(kind_of(String)).once.returns(stub())
+        
+        2.times { response.body }
+      end
+      
+      it "should know if there are errors in the response" do
+        response_xml = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n<rsp stat=\"fail\">\n\t<err code=\"1\" msg=\"User not found\" />\n</rsp>\n"
+        response = Response.new(response_xml)
+        
+        response.error?.should be(true)
+      end
+
+    end
+
+  end
+end

data/test/fleakr/set_test.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class SetTest < Test::Unit::TestCase
+    
+    def mock_request_cycle(options)
+      response = stub(:body => read_fixture(options[:for]))
+      Request.expects(:new).with(options[:for], options[:with]).returns(stub(:send => response))
+    end
+    
+    describe "The Set class" do
+      
+      context "When finding all sets for a user_id" do
+        before do
+          user_id = '31066442@N69'
+          mock_request_cycle :for => 'photosets.getList', :with => {:user_id => user_id}
+          
+          @sets = Set.find_all_by_user_id(user_id)
+        end
+        
+        it "should return an array with the expected number of elements" do
+          @sets.length.should == 2
+        end
+        
+        it "should have the proper titles for each set in the collection" do
+          @sets.map {|s| s.title }.should == ["Second Set", "First Set"]
+        end
+        
+        it "should have the proper descriptions for each set in the collection" do
+          @sets.map {|s| s.description }.should == ['This is the second set.', 'This is the first set.']
+        end
+        
+      end
+    end
+  end
+end

data/test/fleakr/user_test.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Fleakr
+  class UserTest < Test::Unit::TestCase
+
+    describe "The User class" do
+      
+      it "should be able to find a user by his username" do
+        response = stub(:body => read_fixture('people.findByUsername'))
+        Request.expects(:new).with('people.findByUsername', :username => 'frootpantz').returns(stub(:send => response))
+        
+        user = User.find_by_username('frootpantz')
+        
+        user.id.should       == '31066442@N69'
+        user.username.should == 'frootpantz'
+      end
+      
+    end
+    
+    describe "An instance of User" do
+      
+      before do
+        @user_id = '1'
+        
+        @user = User.new
+        @user.stubs(:id).with().returns(@user_id)
+      end
+      
+      it "should retrieve the sets for this user" do
+        sets = [stub()]
+        Set.expects(:find_all_by_user_id).with(@user_id).returns(sets)
+        
+        @user.sets.should == sets
+      end
+      
+      it "should memoize the results returned for this user's sets" do
+        Set.expects(:find_all_by_user_id).once.returns([])
+        
+        2.times { @user.sets }
+      end
+      
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'matchy'
+require 'context'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/fleakr'
+
+class Test::Unit::TestCase
+  
+  def read_fixture(method_call)
+    fixture_path = File.dirname(__FILE__) + '/fixtures'
+    Hpricot.XML(File.read("#{fixture_path}/#{method_call}.xml"))
+  end
+  
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: reagent-fleakr
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Patrick Reagan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-29 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+description: 
+email: reaganpr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- lib/fleakr
+- lib/fleakr/request.rb
+- lib/fleakr/response.rb
+- lib/fleakr/set.rb
+- lib/fleakr/user.rb
+- lib/fleakr/version.rb
+- lib/fleakr.rb
+- test/fixtures
+- test/fixtures/people.findByUsername.xml
+- test/fixtures/photosets.getList.xml
+- test/fleakr
+- test/fleakr/request_test.rb
+- test/fleakr/response_test.rb
+- test/fleakr/set_test.rb
+- test/fleakr/user_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://sneaq.net
+post_install_message: 
+rdoc_options: []
+
+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: A teeny tiny gem to interface with Flickr photostreams
+test_files: []
+