flickr_party 0.3.1 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 124c9c8ab8c4ad7dc62b449929431c0b85b45d4e
+  data.tar.gz: 25dc6fe51bc1ed997b3545bade79a10125f4e7e4
+SHA512:
+  metadata.gz: e65a692fce5a7f94c904117f1cbc731b3460a240b86f6ca5310dde7c67c1e7cd24befeb12109a3d6d8f2a6bb95166d694d8f096454c9d8c7f714e4125ca1a865
+  data.tar.gz: 04cb7b50f136cedd81a139a978cf14873e4c679199727cbb6b66ae290d30471d538af7a7f6ebfe261461a6314993810c79bb814fda75a0fbf9a275ccdb248fa5

data/README.markdown

@@ -1,19 +1,16 @@
-Flickr Party
-============
+# Flickr Party
 
 Flickr Party is the simplest possible thing that might work for you. We build on HTTParty, and do a bit of `method_missing` magic to accept any method that the official Flickr API supports.
 
 You can also (optionally) do authenticated API calls using the `auth_url` and `complete_auth` methods (see below).
 
-Installation
-------------
+## Installation
 
 ```sh
 gem install flickr_party
 ```
-    
-Usage
------
+
+## Usage
 
 ```ruby
 require 'rubygems'
@@ -33,9 +30,17 @@ token = f.complete_auth
 
 # call any API method by calling it on the FlickrParty object directly
 # pass in any needed parameters as a hash
-# pass in the auth_token if authentication is required for this call
-data = f.flickr.activity.userPhotos('timeframe' => '10d', 'auth_token' => token)
+data = f.flickr.activity.userPhotos('timeframe' => '10d')
 
-# data is presented vary raw, in the "rsp" key...
-data['rsp'] # => data
+puts data['photos'].first.url
 ```
+
+## Copyright
+
+Copyright (c) 2014, Tim Morgan
+
+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/lib/flickr_party.rb

@@ -2,82 +2,85 @@ require 'rubygems'
 require 'httparty'
 require 'digest/md5'
 
+require_relative 'flickr_party/methods'
+require_relative 'flickr_party/photo'
+require_relative 'flickr_party/parser'
+
 class FlickrParty
 
   ENDPOINT = 'http://api.flickr.com/services/rest/'
-  
-  class PhotoURLError < RuntimeError; end
-  
+
+  class UnknownMethodNameError < StandardError; end
+  class PhotoURLError < StandardError; end
+
   include HTTParty
   format :xml
-  
+  parser FlickrParser
+
   attr_accessor :token
-  
-  THIRD_LEVEL_METHODS = %w(add browse search delete create find echo login null)
-  
+
   def initialize(api_key, secret, method=nil, token=nil)
     @api_key = api_key
     @secret = secret
     @method = method
     @token = token
   end
-  
-  def method_missing(method_name, args={}, test=nil)
-    if @method.to_s.count('.') == 2 or method_name.to_s =~ /[A-Z]/ or THIRD_LEVEL_METHODS.include?(method_name.to_s)
-      args = self.class.stringify_hash_keys(args)
-      args.merge!('api_key' => @api_key, 'method' => @method + '.' + method_name.to_s)
-      if @token
-        args.merge!('auth_token' => @token)
-      end
-      args_to_s = ""
-      args.sort.each{|a| args_to_s += a[0].to_s + a[1].to_s }
-      sig = Digest::MD5.hexdigest(@secret.to_s + args_to_s)
-      args.merge!(:api_sig => sig)
-      self.class.post(ENDPOINT, :body => args)
+
+  def method_missing(method_part, args={}, test=nil)
+    full_method_name = concat_method(method_part)
+    if is_full_method?(full_method_name)
+      args = merge_args(args, full_method_name)
+      post(args)
     else
-      if @method
-        method = @method + '.' + method_name.to_s
-      else
-        method = method_name.to_s
-      end
-      self.class.new(@api_key, @secret, method, @token)
+      # not an API call -- return a chainable object
+      self.class.new(@api_key, @secret, full_method_name, @token)
     end
   end
-  
+
   def auth_url(perms='read', extra = nil)
-    @frob = self.flickr.auth.getFrob['rsp']['frob']
+    @frob = self.flickr.auth.getFrob['frob']
     sig = Digest::MD5.hexdigest("#{@secret}api_key#{@api_key}extra#{extra}frob#{@frob}perms#{perms}")
     "http://flickr.com/services/auth/?api_key=#{@api_key}&perms=#{perms}&frob=#{@frob}&api_sig=#{sig}&extra=#{extra}"
   end
-  
-  def complete_auth(frob=nil)
-    @frob = frob if frob
-    response = self.flickr.auth.getToken('frob' => @frob)['rsp']
-    if response['stat'] == 'fail'
-      raise response['err']['msg']
-    else
-      @auth = response['auth']
-      @token = @auth['token']
+
+  def complete_auth(frob='put_your_frob_here')
+    @frob ||= frob
+    @auth = self.flickr.auth.getToken('frob' => @frob)['auth']
+    @token = @auth['token']
+  end
+
+private
+
+  def post(args)
+    self.class.post(ENDPOINT, :body => args).tap do |response|
+      if Array === response['photos']
+        response['photos'].map! do |photo_hash|
+          Photo.new(photo_hash)
+        end
+      elsif Hash === response['photos']
+        Photo.new(response['photos'])
+      end
     end
   end
 
-  def photo_url(photo_hash, size=nil)
-    if %w(m s t b).include?(size)
-      "http://farm#{photo_hash['farm']}.static.flickr.com/#{photo_hash['server']}/#{photo_hash['id']}_#{photo_hash['secret']}_#{size}.jpg"
-    elsif size == 'o' and photo_hash['originalsecret'] and photo_hash['originalformat']
-      "http://farm#{photo_hash['farm']}.static.flickr.com/#{photo_hash['server']}/#{photo_hash['id']}_#{photo_hash['originalsecret']}_#{size}.#{photo_hash['originalformat']}"
-    elsif size.nil? or size == '-'
-      "http://farm#{photo_hash['farm']}.static.flickr.com/#{photo_hash['server']}/#{photo_hash['id']}_#{photo_hash['secret']}.jpg"
-    else
-      raise PhotoURLError, "Invalid size or missing keys in photo_hash. Valid sizes are m, s, t, b, o, and nil. For original (o) size, photo_hash must contain both 'originalsecret' and 'originalformat'."
+  def merge_args(arguments, method_name)
+    self.class.stringify_hash_keys(arguments).tap do |args|
+      args.merge!('api_key' => @api_key, 'method' => method_name.to_s)
+      args.merge!('auth_token' => @token) if @token
+      args.merge!('api_sig' => arg_signature(args))
     end
   end
-  
+
+  def arg_signature(args)
+    args_to_s = args.sort.inject('') { |s, (k, v)| s += k.to_s + v.to_s }
+    Digest::MD5.hexdigest(@secret.to_s + args_to_s)
+  end
+
   def self.stringify_hash_keys(hash)
     hash.inject({}) do |options, (key, value)|
       options[key.to_s] = value
       options
     end
   end
-  
+
 end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: flickr_party
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  type: :runtime
   name: httparty
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -37,26 +34,25 @@ files:
 - lib/flickr_party.rb
 homepage: http://github.com/seven1m/flickr_party
 licenses: []
+metadata: {}
 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: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Lightweight wrapper for Flickr API using HTTParty
 test_files: []