flickr_oauth 0.0.1 → 0.0.2

data/README.md

@@ -28,6 +28,20 @@ Or, you can use the `flickr` method:
       :token_secret => OAUTH_ACCESS_TOKEN_SECRET,
       :format => :json
     )
+    
+For photo upload:
+
+    flickr.upload(
+      PATH_TO_IMAGE_FILE
+      :title => 'test upload',            # optional
+      :description => 'this is a test',   # optional
+      :tags => 'test upload',             # optional
+      :content_type => 'image/jpeg',      # optional
+      :consumer_key => CONSUMER_KEY, 
+      :consumer_secret => CONSUMER_SECRET, 
+      :token => OAUTH_ACCESS_TOKEN, 
+      :token_secret => OAUTH_ACCESS_TOKEN_SECRET
+    )
 
 TODO
 -

data/flickr_oauth.gemspec

@@ -23,8 +23,10 @@ Gem::Specification.new do |s|
   
   s.add_dependency 'faraday', '>= 0.7'
   s.add_dependency 'faraday_middleware', '>= 0.7.0.rc1'
-  s.add_dependency 'multi_xml'
+  s.add_dependency 'mime-types'
+  s.add_dependency 'multipart-post'  
   s.add_dependency 'multi_json'
+  s.add_dependency 'multi_xml'  
   s.add_dependency 'simple_oauth'
   s.add_development_dependency 'rspec', '>= 2.6'
   s.add_development_dependency 'webmock', '>= 1.6'

data/lib/flickr.rb

@@ -3,9 +3,196 @@ require 'flickr/client'
 module Flickr
   extend self
   
+  DEFAULT_ENDPOINT = 'http://api.flickr.com'.freeze
+  SECURE_ENDPOINT = 'https://secure.flickr.com'.freeze
+  REST_PATH = '/services/rest'.freeze
+  UPLOAD_PATH = '/services/upload'.freeze
+  REPLACE_PATH = '/services/replace'.freeze
+  
+  METHODS = %w(
+    flickr.activity.userComments
+    flickr.activity.userPhotos
+    flickr.auth.checkToken
+    flickr.auth.getFrob
+    flickr.auth.getFullToken
+    flickr.auth.getToken
+    flickr.auth.oauth.getAccessToken
+    flickr.blogs.getList
+    flickr.blogs.getServices
+    flickr.blogs.postPhoto
+    flickr.collections.getInfo
+    flickr.collections.getTree
+    flickr.commons.getInstitutions
+    flickr.contacts.getList
+    flickr.contacts.getListRecentlyUploaded
+    flickr.contacts.getPublicList
+    flickr.favorites.add
+    flickr.favorites.getList
+    flickr.favorites.getPublicList
+    flickr.favorites.remove
+    flickr.galleries.addPhoto
+    flickr.galleries.create
+    flickr.galleries.editMeta
+    flickr.galleries.editPhoto
+    flickr.galleries.editPhotos
+    flickr.galleries.getInfo
+    flickr.galleries.getList
+    flickr.galleries.getListForPhoto
+    flickr.galleries.getPhotos
+    flickr.groups.browse
+    flickr.groups.getInfo
+    flickr.groups.members.getList
+    flickr.groups.pools.add
+    flickr.groups.pools.getContext
+    flickr.groups.pools.getGroups
+    flickr.groups.pools.getPhotos
+    flickr.groups.pools.remove
+    flickr.groups.search
+    flickr.interestingness.getList
+    flickr.machinetags.getNamespaces
+    flickr.machinetags.getPairs
+    flickr.machinetags.getPredicates
+    flickr.machinetags.getRecentValues
+    flickr.machinetags.getValues
+    flickr.panda.getList
+    flickr.panda.getPhotos
+    flickr.people.findByEmail
+    flickr.people.findByUsername
+    flickr.people.getInfo
+    flickr.people.getPhotos
+    flickr.people.getPhotosOf
+    flickr.people.getPublicGroups
+    flickr.people.getPublicPhotos
+    flickr.people.getUploadStatus
+    flickr.photos.addTags
+    flickr.photos.comments.addComment
+    flickr.photos.comments.deleteComment
+    flickr.photos.comments.editComment
+    flickr.photos.comments.getList
+    flickr.photos.comments.getRecentForContacts
+    flickr.photos.delete
+    flickr.photos.geo.batchCorrectLocation
+    flickr.photos.geo.correctLocation
+    flickr.photos.geo.getLocation
+    flickr.photos.geo.getPerms
+    flickr.photos.geo.photosForLocation
+    flickr.photos.geo.removeLocation
+    flickr.photos.geo.setContext
+    flickr.photos.geo.setLocation
+    flickr.photos.geo.setPerms
+    flickr.photos.getAllContexts
+    flickr.photos.getContactsPhotos
+    flickr.photos.getContactsPublicPhotos
+    flickr.photos.getContext
+    flickr.photos.getCounts
+    flickr.photos.getExif
+    flickr.photos.getFavorites
+    flickr.photos.getInfo
+    flickr.photos.getNotInSet
+    flickr.photos.getPerms
+    flickr.photos.getRecent
+    flickr.photos.getSizes
+    flickr.photos.getUntagged
+    flickr.photos.getWithGeoData
+    flickr.photos.getWithoutGeoData
+    flickr.photos.licenses.getInfo
+    flickr.photos.licenses.setLicense
+    flickr.photos.notes.add
+    flickr.photos.notes.delete
+    flickr.photos.notes.edit
+    flickr.photos.people.add
+    flickr.photos.people.delete
+    flickr.photos.people.deleteCoords
+    flickr.photos.people.editCoords
+    flickr.photos.people.getList
+    flickr.photos.recentlyUpdated
+    flickr.photos.removeTag
+    flickr.photos.search
+    flickr.photos.setContentType
+    flickr.photos.setDates
+    flickr.photos.setMeta
+    flickr.photos.setPerms
+    flickr.photos.setSafetyLevel
+    flickr.photos.setTags
+    flickr.photos.transform.rotate
+    flickr.photos.upload.checkTickets
+    flickr.photosets.addPhoto
+    flickr.photosets.comments.addComment
+    flickr.photosets.comments.deleteComment
+    flickr.photosets.comments.editComment
+    flickr.photosets.comments.getList
+    flickr.photosets.create
+    flickr.photosets.delete
+    flickr.photosets.editMeta
+    flickr.photosets.editPhotos
+    flickr.photosets.getContext
+    flickr.photosets.getInfo
+    flickr.photosets.getList
+    flickr.photosets.getPhotos
+    flickr.photosets.orderSets
+    flickr.photosets.removePhoto
+    flickr.photosets.removePhotos
+    flickr.photosets.reorderPhotos
+    flickr.photosets.setPrimaryPhoto
+    flickr.places.find
+    flickr.places.findByLatLon
+    flickr.places.getChildrenWithPhotosPublic
+    flickr.places.getInfo
+    flickr.places.getInfoByUrl
+    flickr.places.getPlaceTypes
+    flickr.places.getShapeHistory
+    flickr.places.getTopPlacesList
+    flickr.places.placesForBoundingBox
+    flickr.places.placesForContacts
+    flickr.places.placesForTags
+    flickr.places.placesForUser
+    flickr.places.resolvePlaceId
+    flickr.places.resolvePlaceURL
+    flickr.places.tagsForPlace
+    flickr.prefs.getContentType
+    flickr.prefs.getGeoPerms
+    flickr.prefs.getHidden
+    flickr.prefs.getPrivacy
+    flickr.prefs.getSafetyLevel
+    flickr.reflection.getMethodInfo
+    flickr.reflection.getMethods
+    flickr.stats.getCollectionDomains
+    flickr.stats.getCollectionReferrers
+    flickr.stats.getCollectionStats
+    flickr.stats.getCSVFiles
+    flickr.stats.getPhotoDomains
+    flickr.stats.getPhotoReferrers
+    flickr.stats.getPhotosetDomains
+    flickr.stats.getPhotosetReferrers
+    flickr.stats.getPhotosetStats
+    flickr.stats.getPhotoStats
+    flickr.stats.getPhotostreamDomains
+    flickr.stats.getPhotostreamReferrers
+    flickr.stats.getPhotostreamStats
+    flickr.stats.getPopularPhotos
+    flickr.stats.getTotalViews
+    flickr.tags.getClusterPhotos
+    flickr.tags.getClusters
+    flickr.tags.getHotList
+    flickr.tags.getListPhoto
+    flickr.tags.getListUser
+    flickr.tags.getListUserPopular
+    flickr.tags.getListUserRaw
+    flickr.tags.getRelated
+    flickr.test.echo
+    flickr.test.login
+    flickr.test.null
+    flickr.urls.getGroup
+    flickr.urls.getUserPhotos
+    flickr.urls.getUserProfile
+    flickr.urls.lookupGallery
+    flickr.urls.lookupGroup
+    flickr.urls.lookupUser  
+  )
+  
   def new(options = {})
     Flickr::Client.new(options)
-  end
+  end  
 end
 
 def flickr

data/lib/flickr/client.rb

@@ -1,15 +1,16 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday/response/raise_flickr_error'
+require 'flickr/client/authentication'
+require 'flickr/client/connection'
+require 'flickr/client/requests'
+require 'flickr/client/upload'
+
 require 'flickr/node'
 
-module Flickr
+module Flickr  
   class Client
-    DEFAULT_ENDPOINT = 'http://api.flickr.com'.freeze
-    SECURE_ENDPOINT = 'https://secure.flickr.com'.freeze
-    REST_PATH = '/services/rest'.freeze
-    UPLOAD_PATH = '/services/upload'.freeze
-    REPLACE_PATH = '/services/resplace'.freeze
+    include Flickr::Client::Authentication
+    include Flickr::Client::Connection
+    include Flickr::Client::Requests
+    include Flickr::Client::Upload
     
     CONFIGURATION_KEYS = [
       :consumer_key,
@@ -18,8 +19,9 @@ module Flickr
       :token_secret,
       :secure,
       :format,
-      :enable_logging
-    ]
+      :enable_logging,
+      :normalize
+    ]    
   
     attr_accessor *CONFIGURATION_KEYS
   
@@ -30,46 +32,15 @@ module Flickr
     end
     
     def endpoint(secure = false)
-      secure or self.secure  ? SECURE_ENDPOINT : DEFAULT_ENDPOINT
-    end
-    
-    def authentication(options = {})
-      {
-        :consumer_key => consumer_key,
-        :consumer_secret => consumer_secret,
-        :token => token,
-        :token_secret => token_secret
-      }.merge(options.select{|k,v| [:consumer_key, :consumer_secret, :token, :token_secret].include?(k.to_sym)})
-    end
-    
-    def adapter
-      @adapter || Faraday.default_adapter
-    end
-        
-    def connection(options = {})
-      @connection = Faraday.new(:url => endpoint(options[:secure])) do |builder|
-        builder.use Faraday::Request::OAuth, authentication(options)
-        builder.use Faraday::Request::Multipart
-        builder.use Faraday::Request::UrlEncoded
-                
-        builder.use Faraday::Response::RaiseFlickrError
-        if (options[:format] or format).to_s == 'json'
-          builder.use Faraday::Response::ParseJson
-        else
-          builder.use Faraday::Response::ParseXml
-        end        
-        builder.use Faraday::Response::RaiseError
-        builder.use Faraday::Response::Logger if options[:enable_logging] or enable_logging
-        
-        builder.adapter adapter
-      end
+      secure or self.secure  ? Flickr::SECURE_ENDPOINT : Flickr::DEFAULT_ENDPOINT
     end
   
-    protected
+    protected  
   
     def method_missing(method_name, *args)
+      # super unless ['reflection'].include?(method_name.to_s)      
       args.empty? ? Flickr::Node.new(self, ['flickr', method_name].join('.')) : super
-    end    
+    end
     
   end
 end

data/lib/flickr/client/authentication.rb

@@ -0,0 +1,17 @@
+module Flickr
+  class Client
+    module Authentication
+      AUTHENTICATION_KEYS = [:consumer_key, :consumer_secret, :token, :token_secret]
+      
+      def authentication_options(options = {})
+        {
+          :consumer_key => consumer_key,
+          :consumer_secret => consumer_secret,
+          :token => token,
+          :token_secret => token_secret
+        }.merge(options.select{|k,v| AUTHENTICATION_KEYS.include?(k.to_sym)})
+      end
+      
+    end
+  end
+end

data/lib/flickr/client/connection.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/response/raise_flickr_error'
+
+module Flickr
+  class Client
+    module Connection
+    
+      def connection(options = {})
+        @connection = Faraday.new(:url => endpoint(options[:secure])) do |builder|
+          builder.use Faraday::Request::OAuth, authentication_options(options)
+          builder.use Faraday::Request::Multipart
+          builder.use Faraday::Request::UrlEncoded
+                
+          builder.use Faraday::Response::RaiseFlickrError
+          if (options[:format] or format).to_s == 'json'
+            builder.use Faraday::Response::ParseJson
+          else
+            builder.use Faraday::Response::ParseXml
+          end        
+          builder.use Faraday::Response::RaiseError
+          builder.use Faraday::Response::Logger if options[:enable_logging] or enable_logging
+        
+          builder.adapter adapter
+        end
+      end
+    
+      def adapter
+        @adapter || Faraday.default_adapter
+      end    
+    
+      protected
+    
+      def extract_connection_options(params = {})
+        CONFIGURATION_KEYS.inject({}) do |options, k| 
+          if params.has_key?(k)
+            options[k.to_sym] = (k == :format ? params.fetch(k) : params.delete(k))
+          end
+          options
+        end
+      end
+    end
+  end
+end

data/lib/flickr/client/requests.rb

@@ -0,0 +1,69 @@
+module Flickr
+  class Client
+    module Requests
+      
+      def get(path, params = {})
+        request :get, path, params
+      end
+      
+      def post(path, params = {})
+        request :post, path, params        
+      end
+      
+      def put(path, params = {})
+        request :put, path, params        
+      end
+      
+      def delete(path, params = {})
+        request :delete, path, params        
+      end
+    
+      def request(method, path, params = {})
+        params = params.dup
+        options = extract_connection_options(params)
+        
+        if method.to_sym == :get
+          response = connection(options).send(method, build_rest_query(path, params))
+        else
+          response = connection(options).send(method, path, params)
+        end
+        
+        if options[:normalize]
+          options[:format].to_s == 'json' ? normalize_json(response.body) : normalize_xml(response.body)
+        else
+          response.body
+        end
+      end
+    
+      protected
+    
+      def build_rest_query(path, params = {})
+        params[:format] ||= self.format
+        params[:nojsoncallback] = (params[:format].to_s == 'json' ? 1 : nil)
+        query = params.map{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" unless v.nil?}.compact.join("&")
+        [path, query].join("?")
+      end
+      
+      def normalize_json(raw)
+        if raw.is_a?(Hash)
+          if raw.keys.size == 1 and raw.has_key?('_content')
+            raw['_content']
+          else
+            raw.each_pair do |k, v|
+              raw[k] = normalize_json(v)
+            end
+          end
+        elsif raw.is_a?(Array)
+          raw.collect{|r| normalize_json(r) }
+        else
+          raw
+        end
+      end
+      
+      def normalize_xml(xml_result)
+        xml_result['rsp']
+      end
+    
+    end
+  end
+end