wideopenspaces-flickry 0.2.0 → 0.2.1

data/README.markdown

@@ -0,0 +1,122 @@
+# Flickry (by wideopenspac.es)
+
+Flickry is a wrapper for Flickraw that makes working with the Flickr API safe & 
+easy by parsing the Flickraw response into the appropriate objects. 
+
+Now features support for Comments, Tags, Locations (including woeid and place_id 
+for region, county, etc)!
+
+## Installation
+
+    sudo gem install wideopenspaces-flickry
+ 
+## Using with Rails (2.2+)
+
+In `config/environments.rb`, add:
+
+    config.gem "wideopenspaces-flickry", :source => "http://gems.github.com", :lib => 'flickry'
+
+Add the following in `config/initializers/flickr.rb`:
+ 
+    # This is how to authenticate on flickr website.
+    # You need an API key for that, see http://www.flickr.com/services/api/keys/
+    API_KEY='your-api-key-here'
+    SHARED_SECRET='your-secret-here'
+    begin
+      FlickRaw.api_key=API_KEY
+      FlickRaw.shared_secret=SHARED_SECRET
+    rescue
+    end
+
+## Usage
+
+    pic = Flickry::Photo.new 3008067483
+ 
+    pic.urls
+    ["http://www.flickr.com/photos/..."]
+ 
+**Dates**
+ 
+    pic.uploaded_at
+    => Thu Nov 06 13:27:13 -0700 2008
+    pic.taken_at
+    => Tue Nov 04 16:39:46 -0700 2008
+    pic.posted_at
+    => Thu Nov 06 13:27:13 -0700 2008
+    pic.last_updated_at
+    => Sat Jan 10 14:18:29 -0700 2009
+ 
+**License**
+
+    pic.license
+    => "Attribution-NonCommercial-ShareAlike License"
+    pic.license.url
+    => "http://creativecommons.org/licenses/by-nc-sa/2.0/"
+ 
+**Sizes**
+
+    pic.sizes.medium
+    => #<Flickry::Size source="http://farm4.static.flickr.com/....jpg", url="http://www.flickr.com/photos/.../sizes/m/", height="500", media="photo", width="334">
+    
+    pic.sizes.medium.height
+    => "500"
+ 
+**People**
+
+    person = pic.owner
+    => #<Flickry::Person location="", nsid="", realname="", username="", photosurl="", profileurl="">
+    
+    person.profile
+    => "http://www.flickr.com/people/.../"
+    
+    person.photos
+    => "http://www.flickr.com/photos/.../"
+ 
+**Location**
+
+    pic.location
+    => #<Flickry::Location place_id="", region="", woeid="", country="", accuracy="", county="", latitude=41.8, locality="", longitude=-87.6, neighbourhood="">
+    
+    reg = pic.location.region
+    => "Illinois"
+    
+    reg.place_id        # Look ma, that string has methods!
+    => "<place_id>"
+    reg.woeid
+    => "<woeid>"
+ 
+country, region, county, locality, and neighbourhood all *look* like strings but have woeid and place_id attributes.
+
+**Tags**
+
+    pic.tags
+    => ["hdr", "trump", "skyscraper", "skyline"]
+    
+    pic.tag_list
+    => "hdr, trump, skyscraper, skyline"
+
+**Comments**
+
+    pic.comments
+    => ["beautiful", "That HDR trumps others I've seen! Nice work! :)"]
+    
+    pic.comments.last
+    => "That HDR trumps others I've seen! Nice work! :)"
+    
+    pic.comments.last.author
+    => #<Flickry::Person location="", nsid="", realname="", username="", photosurl="", profileurl="">  
+    
+    pic.comments.last.comment_id
+    => "215779-3008067483-72157608738732709"
+    
+    pic.comments.last.created_at
+    => Fri Nov 07 10:38:42 -0700 2008
+    
+    pic.comments.last.permalink
+    => "http://www.flickr.com/photos/unquiet/3008067483/#comment72157608738732709"
+
+
+## Contributing
+
+This thing needs tests! I was running tests against the flickr api directly but want 
+to stub those. If you feel like getting there before I do, go right ahead!

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 2
-:patch: 0
+:patch: 1
 :major: 0

data/lib/flickry.rb

@@ -1,10 +1,59 @@
-require 'flickraw'
+#require 'flickraw'
+require 'httparty'
 require 'super_struct'
 
 require 'flickry/base'
 require 'flickry/location'
 require 'flickry/tag'
 require 'flickry/person'
+require 'flickry/comment'
+require 'flickry/size'
 require 'flickry/sizes'
+require 'flickry/license'
 require 'flickry/photo'
 
+module Flickry
+  VERSION='0.3.0'
+
+  FLICKR_HOST='api.flickr.com'.freeze
+
+  # Path of flickr REST API
+  REST_PATH='/services/rest/?'.freeze
+
+  # Path of flickr auth page
+  AUTH_PATH='/services/auth/?'.freeze
+
+  # Path of flickr upload
+  UPLOAD_PATH='/services/upload/'.freeze
+
+  class Flickr
+    include HTTParty
+    base_uri FLICKR_HOST
+  
+    def initialize # :nodoc:
+    end
+    
+    def authorize(args={})
+      full_args = {:api_key => Flickry.api_key, :perms => 'read'}
+      args.each {|k, v| full_args[k.to_sym] = v }
+      full_args[:api_sig] = Flickry.api_sig(full_args) if Flickry.shared_secret
+      url = 'http://' + Flickry::FLICKR_HOST + Flickry::AUTH_PATH + full_args.collect { |a, v| "#{a}=#{v}" }.join('&')
+      puts url
+      self.class.get(url)
+    end
+  end
+
+  class << self
+    # Your flickr API key, see http://www.flickr.com/services/api/keys for more information
+    attr_accessor :api_key
+
+    # The shared secret of _api_key_, see http://www.flickr.com/services/api/keys for more information
+    attr_accessor :shared_secret
+
+
+    # Returns the signature of hsh. This is meant to be passed in the _api_sig_ parameter.
+    def api_sig(hsh)
+      MD5.md5(Flickry.shared_secret + hsh.sort{|a, b| a[0].to_s <=> b[0].to_s }.flatten.join).to_s
+    end
+  end
+end

data/lib/flickry/license.rb

@@ -0,0 +1,22 @@
+# Flickr has an API method for getting information about licenses
+# but it probably doesn't change all that often. 
+module Flickry
+  class License < String
+    attr_accessor :name, :url
+    def initialize(license)
+      @name, @url = case id.to_i  # License Name                                     Information URL
+      when 1:       ["Attribution-NonCommercial-ShareAlike License",  "http://creativecommons.org/licenses/by-nc-sa/2.0/"]
+      when 2:       ["Attribution-NonCommercial License",             "http://creativecommons.org/licenses/by-nc/2.0/"]
+      when 3:       ["Attribution-NonCommercial-NoDerivs License",    "http://creativecommons.org/licenses/by-nc-nd/2.0/"]
+      when 4:       ["Attribution License",                           "http://creativecommons.org/licenses/by/2.0/"]
+      when 5:       ["Attribution-ShareAlike License",                "http://creativecommons.org/licenses/by-sa/2.0/"]
+      when 6:       ["Attribution-NoDerivs License",                  "http://creativecommons.org/licenses/by-nd/2.0/"]
+      when 7:       ["No known copyright restrictions",               "http://flickr.com/commons/usage/"]
+      else 
+                    ["All Rights Reserved",                           ""]
+      end
+      
+      super(@name)
+    end
+  end
+end

data/lib/flickry/photo.rb

@@ -6,9 +6,9 @@ module Flickry
       self.raw_photo = foto
       self.photo_id = flickr_id
 
-      extract_attrs!(foto, [:dateuploaded, :description, :farm, :id, :isfavorite, :license,
+      extract_attrs!(foto, [:dateuploaded, :description, :farm, :id, :isfavorite,
         :media, :notes, :originalformat, :originalsecret, :rotation, :secret, :server, :tags,
-        :title, :urls])
+        :title])
       extract_attrs_into_substructs!(foto, {
         :dates        => [:lastupdate, :posted, :taken, :takengranularity],
         :editability  => [:canaddmeta, :cancomment],
@@ -17,19 +17,24 @@ module Flickry
         :visibility   => [:isfamily, :isfriend, :ispublic]
       })
       self.location = Flickry::Location.new(foto.respond_to?(:location) ? foto.location : nil)
-      self.owner    = Flickry::Person.new(foto.respond_to?(:owner) ? foto.owner : nil)
-      
+      self.owner    = Flickry::Person.find(foto.respond_to?(:owner) ? foto.owner.nsid : nil)
+      self.license  = Flickry::License.new(foto.respond_to?(:license) ? foto.license : 99)
       _tags = self.tags.dup
       self.tags = _tags.collect do |t|
         Flickry::Tag.new(t)
       end
+      self.urls = foto.urls.collect { |u| u.to_s }
     end
 
+    ##  Sizes
+    
     # Lazily fetches the photo's sizes when called, memoizes so later calls are faster...
     def sizes
       @sizes ||= Flickry::Sizes.new(flickr.photos.getSizes(:photo_id => self.photo_id))
     end
     
+    ##  Comments
+    
     # Lazily fetches the photo's comments when called, memoizes so later calls are faster...
     def comments
       return @comments if @comments
@@ -44,13 +49,40 @@ module Flickry
         end
       end
       return @comments
-    end     
+    end 
+    
+    ##  Time/Dates
+    def last_updated_at
+      dates_to_time(:lastupdate)
+    end
+    
+    def posted_at
+      dates_to_time(:posted)
+    end
+    
+    def taken_at
+      Time.parse(self.dates.taken)
+    end
+    
+    def uploaded_at
+      uploaded = self.dateuploaded.to_i
+      return nil if uploaded == 0
+      Time.at(uploaded)    
+    end
+    
+    ## Tags
     
     # Join tags into a single string 
     def tag_list(separator = ', ')
       self.tags.join(separator)
     end
     
+    #W Booleans
+    
+    def favorite?
+      self.isfavorite == 1
+    end
+    
     def visible_to_family?
       self.visibility.isfamily == 1
     end
@@ -63,5 +95,13 @@ module Flickry
       self.visibility.ispublic == 1
     end
     
+    private
+    
+    def dates_to_time(src)
+      time = self.dates.send(src).to_i
+      return nil if time == 0
+      Time.at(time)
+    end
+    
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wideopenspaces-flickry
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jacob Stetser
@@ -9,18 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-21 00:00:00 -08:00
-default_executable: 
+date: 2009-01-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: wideopenspaces-flickraw
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
         version: 0.5.2
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: Interface to Flickr API to make working with API responses safer and easier. DO NOT USE ME YET!
 email: jake@wideopenspac.es
 executables: []
@@ -30,10 +42,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.markdown
 - VERSION.yml
-- lib/flickry
 - lib/flickry/base.rb
 - lib/flickry/comment.rb
+- lib/flickry/license.rb
 - lib/flickry/location.rb
 - lib/flickry/person.rb
 - lib/flickry/photo.rb
@@ -45,8 +58,9 @@ files:
 - lib/super_struct.rb
 - test/flickry_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/wideopenspaces/flickry
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --inline-source
@@ -54,21 +68,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 2
 summary: Friendlier interface to flickr API, uses flickraw underneath