flickrie 0.2.2 → 0.3.0

data/Gemfile

@@ -8,3 +8,7 @@ group :development, :test do
   gem "flickrie", :path => "~/Projects/flickrie"
   gem "pry"
 end
+
+group :test do
+  gem "turn"
+end

data/README.md

@@ -27,8 +27,8 @@ You first need to install the gem.
 [sudo] gem install flickrie
 ```
 
-Then in your app you set the API key and secret (which you can apply
-for [here](http://www.flickr.com/services/apps/create/apply)).
+Then in your app you set the API key and secret (if you don't have them
+already, you can apply for them [here](http://www.flickr.com/services/apps/create/apply)).
 
 ```ruby
 require 'flickrie'
@@ -140,15 +140,25 @@ request_token.get_authorization_url(:permissions => "read")
 to ask only for "read" permissions from the user. Available permissions
 are "read", "write" and "delete".
 
-To see how to make authentication in a web application, see [this](https://github.com/janko-m/flickrie/wiki/Authentication-in-web-applications) wiki
-page.
+If you want to make authentication in your web application, check out my [flickr_auth](https://github.com/janko-m/flickr_auth) gem.
+Or, if you want to do it manually, check out [this wiki](https://github.com/janko-m/flickrie/wiki/Authentication-in-web-applications) for instructions.
 
 ## A few words
 
-Now, I covered only a few out of many Flickr's API methods using this approach, but I'll constantly update this gem with new API methods. For all of the methods I didn't cover, you can call them using `Flickrie.client`, like this:
+Now, I covered only a few out of many Flickr's API methods using this approach,
+but I'll constantly update this gem with new API methods. For all of the methods
+I didn't cover, you can still call them using
+
+```ruby
+Flickrie.client.get(method_name, params = {})
+Flickrie.client.post(method_name, params = {})
+```
+
+For example:
 
 ```ruby
 response = Flickrie.client.get "flickr.photos.getContext", :photo_id => 2842732
+
 reponse.body # =>
 # {
 #   "count" => {"_content" => 99},
@@ -163,9 +173,12 @@ reponse.body # =>
 #     ...
 #   }
 # }
+response.body['prevphoto']['id'] # => "6946978706"
 ```
 
-It's not nearly as pretty, but at least you can get to the data.
+It's not nearly as pretty, but at least you can get to the data for the
+time being. Notice that the `:api_key` parameter is always passed in by
+default.
 
 ## Issues
 
@@ -180,27 +193,29 @@ basis of this gem.
 
 ## Currently covered API methods
 
-### people
-- `flickr.people.findByEmail`
-- `flickr.people.findByUsername`
-- `flickr.people.getInfo`
-- `flickr.people.getPublicPhotos`
-
-### photos
-- `flickr.photos.addTags`
-- `flickr.photos.delete`
-- `flickr.photos.getInfo`
-- `flickr.photos.getSizes`
-- `flickr.photos.removeTag`
-- `flickr.photos.search`
-
-### photos.licenses
-- `flickr.photos.licenses.getInfo`
-
-### photosets
-- `flickr.photosets.getInfo`
-- `flickr.photosets.getList`
-- `flickr.photosets.getPhotos`
+```ruby
+# people
+"flickr.people.findByEmail"      -> Flickrie.find_user_by_email
+"flickr.people.findByUsername"   -> Flickrie.find_user_by_username
+"flickr.people.getInfo"          -> Flickrie.get_user_info
+"flickr.people.getPublicPhotos"  -> Flickrie.public_photos_from_user
+
+# photos
+"flickr.photos.addTags"          -> Flickrie.add_photo_tags
+"flickr.photos.delete"           -> Flickrie.delete_photo
+"flickr.photos.getInfo"          -> Flickrie.get_photo_info
+"flickr.photos.getSizes"         -> Flickrie.get_photo_sizes
+"flickr.photos.removeTag"        -> Flickrie.remove_photo_tag
+"flickr.photos.search"           -> Flickrie.search_photos
+
+# photos.licenses
+"flickr.photos.licenses.getInfo" -> Flickrie.get_licenses
+
+# photosets
+"flickr.photosets.getInfo"       -> Flickrie.get_set_info
+"flickr.photosets.getList"       -> Flickrie.sets_from_user
+"flickr.photosets.getPhotos"     -> Flickrie.photos_from_set
+```
 
 ## License
 

data/Rakefile

@@ -5,7 +5,7 @@ CURRENT_DIR = File.expand_path(File.dirname(__FILE__))
 
 task :test do
   Dir["#{CURRENT_DIR}/test/**/*_test.rb"].each do |test|
-    system "ruby -Ilib -Itest #{test}"
+    system "turn -Ilib -Itest #{test}"
   end
 end
 
@@ -13,7 +13,7 @@ namespace :test do
   test_rbs = Dir["#{CURRENT_DIR}/test/*_test.rb"]
   test_rbs.map { |t| File.basename(t).chomp('_test.rb') }.each do |test_name|
     task(test_name.to_sym) do
-      system "ruby -Ilib -Itest test/#{test_name}_test.rb"
+      system "turn -Ilib -Itest test/#{test_name}_test.rb"
     end
   end
 end

data/lib/flickrie/api_methods.rb

@@ -0,0 +1,117 @@
+require 'flickrie/client'
+require 'flickrie/oauth'
+require 'flickrie/license'
+require 'flickrie/user'
+require 'flickrie/media'
+require 'flickrie/photo'
+require 'flickrie/video'
+require 'flickrie/set'
+
+module Flickrie
+  module ApiMethods
+    # people
+    def find_user_by_email(email)
+      response = client.find_user_by_email(email)
+      User.from_find(response.body['user'])
+    end
+
+    def find_user_by_username(username)
+      response = client.find_user_by_username(username)
+      User.from_find(response.body['user'])
+    end
+
+    def get_user_info(user_nsid)
+      response = client.get_user_info(user_nsid)
+      User.from_info(response.body['person'])
+    end
+
+    def public_media_from_user(user_nsid, params = {})
+      response = client.public_media_from_user(user_nsid, params)
+      Media.from_user(response.body['photos'])
+    end
+    def public_photos_from_user(user_nsid, params = {})
+      public_media_from_user(user_nsid, params).select do |media|
+        media.is_a?(Photo)
+      end
+    end
+    def public_videos_from_user(user_nsid, params = {})
+      public_media_from_user(user_nsid, params).select do |media|
+        media.is_a?(Video)
+      end
+    end
+
+    # photos
+    def add_media_tags(media_id, tags)
+      client.add_media_tags(media_id, tags)
+    end
+    alias add_photo_tags add_media_tags
+    alias add_video_tags add_media_tags
+
+    def delete_media(media_id)
+      client.delete_media(media_id)
+    end
+    alias delete_photo delete_media
+    alias delete_video delete_media
+
+    def get_media_info(media_id)
+      response = client.get_media_info(media_id)
+      Media.from_info(response.body['photo'])
+    end
+    alias get_photo_info get_media_info
+    alias get_video_info get_media_info
+
+    def get_photo_sizes(photo_id)
+      response = client.get_media_sizes(photo_id)
+      Photo.from_sizes(response.body['sizes'])
+    end
+    def get_video_sizes(video_id)
+      response = client.get_media_sizes(video_id)
+      Video.from_sizes(response.body['sizes'])
+    end
+
+    def remove_media_tag(tag_id)
+      client.remove_media_tag(tag_id)
+    end
+    alias remove_photo_tag remove_media_tag
+    alias remove_video_tag remove_media_tag
+
+    def search_media(search_params = {})
+      response = client.search_media(search_params)
+      Media.from_search(response.body['photos'])
+    end
+    def search_photos(search_params = {})
+      search_media(search_params.merge(:media => 'photos'))
+    end
+    def search_videos(search_params = {})
+      search_media(search_params.merge(:media => 'videos'))
+    end
+
+    # licenses
+    def get_licenses
+      response = client.get_licenses
+      License.from_hash(response.body['licenses']['license'])
+    end
+
+    # photosets
+    def get_set_info(set_id)
+      response = client.get_set_info(set_id)
+      Set.from_info(response.body['photoset'])
+    end
+
+    def sets_from_user(user_nsid)
+      response = client.sets_from_user(user_nsid)
+      Set.from_user(response.body['photosets']['photoset'], user_nsid)
+    end
+
+    def media_from_set(set_id, params = {})
+      response = client.media_from_set(set_id, params)
+      Media.from_set(response.body['photoset'])
+    end
+    def photos_from_set(set_id, params = {})
+      media_from_set(set_id, params.merge(:media => 'photos'))
+    end
+    def videos_from_set(set_id, params = {})
+      media_from_set(set_id, params.merge(:media => 'videos'))
+    end
+  end
+end

data/lib/flickrie/client.rb

@@ -1,23 +1,34 @@
 require 'faraday_middleware'
-require 'simple_oauth'
 
 module Flickrie
   class << self
-    attr_accessor :api_key, :shared_secret, :timeout, :open_timeout,
-      :access_token, :access_secret
+    def self.attr_accessor_with_client_reset(*attributes)
+      attr_reader *attributes
 
-    def client
+      attributes.each do |attribute|
+        define_method "#{attribute}=" do |value|
+          instance_variable_set "@#{attribute}", value
+          @client = nil
+        end
+      end
+    end
+
+    attr_accessor_with_client_reset :api_key, :shared_secret,
+      :timeout, :open_timeout, :access_token, :access_secret
+
+    def client(access_token_hash = {})
       @client ||= begin
         client = Client.new(params) do |conn|
           conn.request :oauth,
             :consumer_key => api_key,
             :consumer_secret => shared_secret,
-            :token => access_token,
-            :token_secret => access_secret
+            :token => access_token_hash[:token] || access_token,
+            :token_secret => access_token_hash[:secret] || access_secret
           conn.response :json, :content_type => /(text\/plain)|(json)$/
           conn.adapter Faraday.default_adapter
         end
 
+        client.builder.insert_after FaradayMiddleware::ParseJson, OAuthStatusCheck
         client.builder.insert_before FaradayMiddleware::ParseJson, StatusCheck
         client
       end
@@ -52,6 +63,15 @@ module Flickrie
     end
   end
 
+  class OAuthStatusCheck < Faraday::Response::Middleware
+    def on_complete(env)
+      if env[:status] != 200
+        message = env[:body][/(?<=oauth_problem=)[^&]+/]
+        raise Error, message.gsub('_', ' ').capitalize
+      end
+    end
+  end
+
   class Client < Faraday::Connection
     def get(method, params = {})
       super() do |req|

data/lib/flickrie/instance.rb

@@ -0,0 +1,15 @@
+module Flickrie
+  class Instance
+    attr_reader :access_token, :access_secret
+
+    def initialize(access_token, access_secret)
+      @access_token, @access_secret = access_token, access_secret
+    end
+
+    def client
+      Flickrie.client(:token => access_token, :secret => access_secret)
+    end
+
+    include ApiMethods
+  end
+end

data/lib/flickrie/version.rb

@@ -1,3 +1,3 @@
 module Flickrie
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/flickrie.rb

@@ -1,117 +1,6 @@
-require 'flickrie/client'
-require 'flickrie/oauth'
-require 'flickrie/license'
-require 'flickrie/user'
-require 'flickrie/media'
-require 'flickrie/photo'
-require 'flickrie/video'
-require 'flickrie/set'
+require 'flickrie/api_methods'
+require 'flickrie/instance'
 
 module Flickrie
-  class << self
-    # people
-    def find_user_by_email(email)
-      response = client.find_user_by_email(email)
-      User.from_find(response.body['user'])
-    end
-
-    def find_user_by_username(username)
-      response = client.find_user_by_username(username)
-      User.from_find(response.body['user'])
-    end
-
-    def get_user_info(user_nsid)
-      response = client.get_user_info(user_nsid)
-      User.from_info(response.body['person'])
-    end
-
-    def public_media_from_user(user_nsid, params = {})
-      response = client.public_media_from_user(user_nsid, params)
-      Media.from_user(response.body['photos'])
-    end
-    def public_photos_from_user(user_nsid, params = {})
-      public_media_from_user(user_nsid, params).select do |media|
-        media.is_a?(Photo)
-      end
-    end
-    def public_videos_from_user(user_nsid, params = {})
-      public_media_from_user(user_nsid, params).select do |media|
-        media.is_a?(Video)
-      end
-    end
-
-    # photos
-    def add_media_tags(media_id, tags)
-      client.add_media_tags(media_id, tags)
-    end
-    alias add_photo_tags add_media_tags
-    alias add_video_tags add_media_tags
-
-    def delete_media(media_id)
-      client.delete_media(media_id)
-    end
-    alias delete_photo delete_media
-    alias delete_video delete_media
-
-    def get_media_info(media_id)
-      response = client.get_media_info(media_id)
-      Media.from_info(response.body['photo'])
-    end
-    alias get_photo_info get_media_info
-    alias get_video_info get_media_info
-
-    def get_photo_sizes(photo_id)
-      response = client.get_media_sizes(photo_id)
-      Photo.from_sizes(response.body['sizes'])
-    end
-    def get_video_sizes(video_id)
-      response = client.get_media_sizes(video_id)
-      Video.from_sizes(response.body['sizes'])
-    end
-
-    def remove_media_tag(tag_id)
-      client.remove_media_tag(tag_id)
-    end
-    alias remove_photo_tag remove_media_tag
-    alias remove_video_tag remove_media_tag
-
-    def search_media(search_params = {})
-      response = client.search_media(search_params)
-      Media.from_search(response.body['photos'])
-    end
-    def search_photos(search_params = {})
-      search_media(search_params.merge(:media => 'photos'))
-    end
-    def search_videos(search_params = {})
-      search_media(search_params.merge(:media => 'videos'))
-    end
-
-    # licenses
-    def get_licenses
-      response = client.get_licenses
-      License.from_hash(response.body['licenses']['license'])
-    end
-
-    # photosets
-    def get_set_info(set_id)
-      response = client.get_set_info(set_id)
-      Set.from_info(response.body['photoset'])
-    end
-
-    def sets_from_user(user_nsid)
-      response = client.sets_from_user(user_nsid)
-      Set.from_user(response.body['photosets']['photoset'], user_nsid)
-    end
-
-    def media_from_set(set_id, params = {})
-      response = client.media_from_set(set_id, params)
-      Media.from_set(response.body['photoset'])
-    end
-    def photos_from_set(set_id, params = {})
-      media_from_set(set_id, params.merge(:media => 'photos'))
-    end
-    def videos_from_set(set_id, params = {})
-      media_from_set(set_id, params.merge(:media => 'videos'))
-    end
-  end
+  extend ApiMethods
 end

data/test/client_test.rb

@@ -1,10 +1,9 @@
 # encoding: utf-8
-require 'test/unit'
+require 'test'
 require 'flickrie/client'
 
 class ClientTest < Test::Unit::TestCase
   def setup
-    Flickrie.api_key = ENV['FLICKR_API_KEY']
     @client = Flickrie.client
     @set_id = 72157629851991663
     @media_id = 7093038981

data/test/instance_test.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+require 'flickrie'
+
+class InstanceTest < Test::Unit::TestCase
+  def test_if_it_works
+    Flickrie.api_key = ENV['FLICKR_API_KEY']
+    Flickrie.shared_secret = ENV['FLICKR_SHARED_SECRET']
+
+    flickr = Flickrie::Instance.new \
+      ENV['FLICKR_ACCESS_TOKEN'], ENV['FLICKR_ACCESS_SECRET']
+
+    photo_id = 6946979188
+    flickr.add_photo_tags(photo_id, "janko")
+    photo = flickr.get_photo_info(photo_id)
+
+    tag = photo.tags.find { |tag| tag.content == "janko" }
+    assert_not_nil tag
+
+    flickr.remove_photo_tag tag.id
+  end
+end

data/test/license_test.rb

@@ -1,4 +1,4 @@
-require 'test/unit'
+require 'test'
 require 'flickrie'
 
 Flickrie::License.instance_eval do
@@ -8,10 +8,6 @@ Flickrie::License.instance_eval do
 end
 
 class LicenseTest < Test::Unit::TestCase
-  def setup
-    Flickrie.api_key = ENV['FLICKR_API_KEY']
-  end
-
   def test_licenses_staying_the_same
     licenses_array = Flickrie.client.get_licenses.body['licenses']['license']
     assert_equal licenses_array.sort_by { |hash| hash['id'] },

data/test/location_test.rb

@@ -1,4 +1,4 @@
-require 'test/unit'
+require 'test'
 require 'flickrie/location'
 
 class LocationTest < Test::Unit::TestCase

data/test/media_test.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require 'test/unit'
+require 'test'
 require 'flickrie'
 
 Flickrie::Photo.instance_eval do
@@ -10,10 +10,6 @@ end
 
 class MediaTest < Test::Unit::TestCase
   def setup
-    Flickrie.api_key = ENV['FLICKR_API_KEY']
-    Flickrie.shared_secret = ENV['FLICKR_SHARED_SECRET']
-    Flickrie.access_token = ENV['FLICKR_ACCESS_TOKEN']
-    Flickrie.access_secret = ENV['FLICKR_ACCESS_SECRET']
     @media_id = 6946979188
     @set_id = 72157629851991663
     @user_nsid = '67131352@N04'

data/test/photo_test.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require 'test/unit'
+require 'test'
 require 'flickrie'
 
 Flickrie::Photo.instance_eval do
@@ -10,7 +10,6 @@ end
 
 class PhotoTest < Test::Unit::TestCase
   def setup
-    Flickrie.api_key = ENV['FLICKR_API_KEY']
     @photo_id = 6946979188
     @set_id = 72157629851991663
     @user_nsid = '67131352@N04'
@@ -43,8 +42,8 @@ class PhotoTest < Test::Unit::TestCase
 
   def get_sizes_assertions(photo)
     assert_equal true, photo.can_download?
-    assert_equal false, photo.can_blog?
-    assert_equal false, photo.can_print?
+    assert_equal true, photo.can_blog?
+    assert_equal true, photo.can_print?
 
     assert_sizes(photo)
   end

data/test/set_test.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require 'test/unit'
+require 'test'
 require 'flickrie'
 
 Flickrie::Set.instance_eval do
@@ -10,7 +10,6 @@ end
 
 class SetTest < Test::Unit::TestCase
   def setup
-    Flickrie.api_key = ENV['FLICKR_API_KEY']
     @set_id = 72157629851991663
     @user_nsid = '67131352@N04'
   end
@@ -41,7 +40,7 @@ class SetTest < Test::Unit::TestCase
     assert set.media.find { |media| media.is_a?(Flickrie::Photo) }
     assert set.media.find { |media| media.is_a?(Flickrie::Video) }
 
-    assert_equal false, set.can_comment?
+    assert_equal true, set.can_comment?
 
     assert_instance_of Time, set.created_at
     assert_instance_of Time, set.updated_at
@@ -73,7 +72,7 @@ class SetTest < Test::Unit::TestCase
     assert set.media.find { |media| media.is_a?(Flickrie::Photo) }
     assert set.media.find { |media| media.is_a?(Flickrie::Video) }
 
-    assert_equal false, set.can_comment?
+    assert_equal true, set.can_comment?
     assert_equal false, set.needs_interstitial?
     assert_equal true, set.visibility_can_see_set?
 

data/test/test.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require 'flickrie/client'
+
+Flickrie.timeout = 20
+Flickrie.open_timeout = 20
+Flickrie.api_key = ENV['FLICKR_API_KEY']
+Flickrie.shared_secret = ENV['FLICKR_SHARED_SECRET']
+Flickrie.access_token = ENV['FLICKR_ACCESS_TOKEN']
+Flickrie.access_secret = ENV['FLICKR_ACCESS_SECRET']

data/test/user_test.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require 'test/unit'
+require 'test'
 require 'flickrie'
 
 Flickrie::User.instance_eval do
@@ -10,7 +10,6 @@ end
 
 class UserTest < Test::Unit::TestCase
   def setup
-    Flickrie.api_key = ENV['FLICKR_API_KEY']
     @user_nsid = '67131352@N04'
   end
 

data/test/video_test.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require 'test/unit'
+require 'test'
 require 'flickrie'
 
 Flickrie::Video.instance_eval do
@@ -10,7 +10,6 @@ end
 
 class VideoTest < Test::Unit::TestCase
   def setup
-    Flickrie.api_key = ENV['FLICKR_API_KEY']
     @video_id = 7093038981
     @set_id = 72157629851991663
     @user_nsid = '67131352@N04'
@@ -45,8 +44,8 @@ class VideoTest < Test::Unit::TestCase
 
   def get_sizes_assertions(video)
     assert_equal true, video.can_download?
-    assert_equal false, video.can_blog?
-    assert_equal false, video.can_print?
+    assert_equal true, video.can_blog?
+    assert_equal true, video.can_print?
 
     refute video.source_url.empty?
     refute video.download_url.empty?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrie
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-26 00:00:00.000000000 Z
+date: 2012-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70320778626240 !ruby/object:Gem::Requirement
+  requirement: &70199659891200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320778626240
+  version_requirements: *70199659891200
 - !ruby/object:Gem::Dependency
   name: simple_oauth
-  requirement: &70320778623960 !ruby/object:Gem::Requirement
+  requirement: &70199659890040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320778623960
+  version_requirements: *70199659890040
 description: This gem is a nice wrapper for the Flickr API with an intuitive interface.
 email:
 - janko.marohnic@gmail.com
@@ -47,7 +47,9 @@ files:
 - Rakefile
 - flickrie.gemspec
 - lib/flickrie.rb
+- lib/flickrie/api_methods.rb
 - lib/flickrie/client.rb
+- lib/flickrie/instance.rb
 - lib/flickrie/license.rb
 - lib/flickrie/location.rb
 - lib/flickrie/media.rb
@@ -61,12 +63,14 @@ files:
 - lib/flickrie/version.rb
 - lib/flickrie/video.rb
 - test/client_test.rb
+- test/instance_test.rb
 - test/license_test.rb
 - test/location_test.rb
 - test/media_test.rb
 - test/oauth_test.rb
 - test/photo_test.rb
 - test/set_test.rb
+- test/test.rb
 - test/user_test.rb
 - test/video_test.rb
 homepage: https://github.com/janko-m/flickrie
@@ -98,12 +102,14 @@ summary: The reason why I did this gem is because the other ones either weren't
   a while you realize it's not pretty. So I wanted to make it pretty :)
 test_files:
 - test/client_test.rb
+- test/instance_test.rb
 - test/license_test.rb
 - test/location_test.rb
 - test/media_test.rb
 - test/oauth_test.rb
 - test/photo_test.rb
 - test/set_test.rb
+- test/test.rb
 - test/user_test.rb
 - test/video_test.rb
 has_rdoc: