flickrie 0.5.2 → 0.6.0

data/.gitignore

@@ -1,5 +1,4 @@
 TODO.md
 Gemfile.lock
-*.gem
 pkg/
 credentials.rb

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Flickrie changelog
 
+## Version 0.6.0
+
+- you can access the raw response hash with square brackets, if you notice I
+  didn't cover some part of it with methods. So, for example, `photo['id']`
+  will access the photo's ID.
+
+- when `Flickrie::Error` is raises, you can now access its `#code`
+  attribute. This makes better error handling, because error code
+  is (supposed to be) unique, unlike the error message
+
 ## Version 0.5.2
 
 - the gem now also works with Faraday 0.7 (I apologize for not

data/Gemfile

@@ -5,12 +5,13 @@ gemspec
 gem "faraday", "~> 0.7.6"
 
 group :development, :test do
-  gem "activesupport"
   gem "flickrie", :path => "~/Projects/flickrie"
   gem "pry"
   gem "debugger"
 end
 
 group :test do
-  gem "turn"
+  # This is to get rid of 'gem install minitest' messages
+  # in the tests
+  gem "minitest"
 end

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_file|
-    system "bundle exec turn -Itest #{test_file}"
+    system "bundle exec turn -Itest --require=test_helper #{test_file}"
   end
 end
 
@@ -14,7 +14,12 @@ namespace :test do
     map { |t| [File.basename(t).chomp('_test.rb').to_sym, t] }.
       each do |test_name, test_file|
         task(test_name) do
-          system "bundle exec turn -Itest #{test_file}"
+          system "bundle exec turn -Itest --require=test_helper #{test_file}"
         end
       end
 end
+
+task :rdoc do
+  system "rm -rf doc/"
+  system "rdoc lib/"
+end

data/flickrie.gemspec

@@ -21,4 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "multi_xml", '~> 0.4'
 
   gem.add_development_dependency "activesupport"
+  gem.add_development_dependency "turn"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "webmock"
 end

data/lib/flickrie/api_methods.rb

@@ -29,6 +29,7 @@ module Flickrie
       end
     end
 
+    #--
     # people
     def find_user_by_email(email)
       response = client.find_user_by_email(email)
@@ -58,6 +59,7 @@ module Flickrie
         select { |media| media.is_a?(Video) }
     end
 
+    #--
     # photos
     def add_media_tags(media_id, tags)
       client.add_media_tags(media_id, tags)
@@ -160,6 +162,7 @@ module Flickrie
       search_media(search_params.merge(:media => 'videos'))
     end
 
+    #--
     # photos.upload
     def check_upload_tickets(tickets)
       tickets = tickets.join(',') if tickets.respond_to?(:join)
@@ -168,12 +171,14 @@ module Flickrie
         map { |info| Media::Ticket.new(info) }
     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)

data/lib/flickrie/client.rb

@@ -2,6 +2,7 @@ require 'faraday_middleware'
 
 module Flickrie
   class << self
+    # :nodoc:
     def self.attr_accessor_with_client_reset(*attributes)
       attr_reader *attributes
 
@@ -54,17 +55,24 @@ module Flickrie
   end
 
   class Error < StandardError
+    attr_reader :code
+
+    def initialize(message, code = nil)
+      super(message)
+      @code = code.to_i
+    end
   end
 
-  class StatusCheck < Faraday::Response::Middleware
+  class StatusCheck < Faraday::Response::Middleware # :nodoc:
     def on_complete(env)
       if env[:body]['stat'] != 'ok'
-        raise Error, env[:body]['message']
+        raise Error.new(env[:body]['message'], env[:body]['code']),
+          env[:body]['message']
       end
     end
   end
 
-  class OAuthStatusCheck < Faraday::Response::Middleware
+  class OAuthStatusCheck < Faraday::Response::Middleware # :nodoc:
     def on_complete(env)
       if env[:status] != 200
         message = env[:body][/(?<=oauth_problem=)[^&]+/]
@@ -88,6 +96,7 @@ module Flickrie
       end
     end
 
+    #--
     # people
     def find_user_by_email(email)
       get 'flickr.people.findByEmail', :find_email => email
@@ -106,6 +115,7 @@ module Flickrie
       get 'flickr.people.getPublicPhotos', ensure_media(params)
     end
 
+    #--
     # photos
     def add_media_tags(media_id, tags)
       post 'flickr.photos.addTags', :photo_id => media_id, :tags => tags
@@ -152,16 +162,19 @@ module Flickrie
       get 'flickr.photos.search', ensure_media(params)
     end
 
+    #--
     # photos.upload
     def check_upload_tickets(tickets)
       get 'flickr.photos.upload.checkTickets', :tickets => tickets
     end
 
-    # licenses
+    #--
+    # photos.licenses
     def get_licenses
       get 'flickr.photos.licenses.getInfo'
     end
 
+    #--
     # photosets
     def get_set_info(set_id)
       get 'flickr.photosets.getInfo', :photoset_id => set_id

data/lib/flickrie/location.rb

@@ -1,62 +1,35 @@
 module Flickrie
   class Location
-    %w[latitude longitude accuracy context place_id woeid].each do |attr_name|
-      define_method(attr_name) do
-        @info[attr_name]
-      end
-    end
+    attr_reader :latitude, :longitude, :accuracy, :context, :place_id,
+      :woeid
 
-    %w[neighbourhood locality county region country].each do |place_name|
-      define_method(place_name) do
-        if @info[place_name]
-          Struct.new(:name, :place_id, :woeid).new \
-            @info[place_name]['_content'],
-            @info[place_name]['place_id'],
-            @info[place_name]['woeid']
-        end
-      end
+    def neighbourhood; place('neighbourhood') end
+    def locality;      place('locality')      end
+    def county;        place('county')        end
+    def region;        place('region')        end
+    def country;       place('country')       end
+
+    def [](key)
+      @info[key]
     end
 
     private
 
     def initialize(info = {})
       @info = info
+
+      %w[latitude longitude accuracy context place_id woeid].each do |attribute|
+        instance_variable_set "@#{attribute}", @info[attribute]
+      end
+    end
+
+    def place(place_name)
+      if @info[place_name]
+        Struct.new(:name, :place_id, :woeid).new \
+          @info[place_name]['_content'],
+          @info[place_name]['place_id'],
+          @info[place_name]['woeid']
+      end
     end
   end
 end
-
-__END__
-
-{
-  "latitude" => 37.792608,
-  "longitude" => -122.402672,
-  "accuracy" => "14",
-  "context" => "0",
-  "neighbourhood" => {
-    "_content" => "Financial District",
-    "place_id" => "GddgqTpTUb8LgT93hw",
-    "woeid" => "23512022"
-  },
-  "locality" => {
-    "_content" => "San Francisco",
-    "place_id" => "7.MJR8tTVrIO1EgB",
-    "woeid" => "2487956"
-  },
-  "county" => {
-    "_content" => "San Francisco",
-    "place_id" => ".7sOmlRQUL9nK.kMzA",
-    "woeid" => "12587707"
-  },
-  "region" => {
-    "_content" => "California",
-    "place_id" => "NsbUWfBTUb4mbyVu",
-    "woeid" => "2347563"
-  },
-  "country" => {
-    "_content" => "United States",
-    "place_id" => "nz.gsghTUb4c2WAecA",
-    "woeid" => "23424977"
-  },
-  "place_id" =>"GddgqTpTUb8LgT93hw",
-  "woeid" =>"23512022"
-}

data/lib/flickrie/media/exif.rb

@@ -10,6 +10,10 @@ module Flickrie
         raise Error, "The information about '#{key}' doesn't exist"
       end
 
+      def [](key)
+        @info[key]
+      end
+
       def initialize(info)
         @info = info
       end

data/lib/flickrie/media/tag.rb

@@ -13,6 +13,10 @@ module Flickrie
         User.new('nsid' => @info['author']) if @info['author']
       end
 
+      def [](key)
+        @info[key]
+      end
+
       def initialize(info)
         @info = info
       end

data/lib/flickrie/media/ticket.rb

@@ -14,6 +14,10 @@ module Flickrie
         Time.at(@info['imported'].to_i)
       end
 
+      def [](key)
+        @info[key]
+      end
+
       def initialize(info)
         @info = info
       end

data/lib/flickrie/media/visibility.rb

@@ -1,13 +1,17 @@
 module Flickrie
   module Media
     class Visibility
-      def public?;   @visibility[0].to_i == 1 if @visibility[0]   end
-      def friends?;  @visibility[1].to_i == 1 if @visibility[1]   end
-      def family?;   @visibility[2].to_i == 1 if @visibility[2]   end
-      def contacts?; @visibility[3].to_i == 1 if @visibility[3]   end
+      def public?;   @info['ispublic'].to_i == 1 if @info['ispublic']   end
+      def friends?;  @info['isfriend'].to_i == 1 if @info['isfriend']   end
+      def family?;   @info['isfamily'].to_i == 1 if @info['isfamily']   end
+      def contacts?; @info['iscontact'].to_i == 1 if @info['iscontact'] end
 
-      def initialize(*visibility)
-        @visibility = visibility.flatten
+      def [](key)
+        @info[key]
+      end
+
+      def initialize(info)
+        @info = info
       end
     end
   end

data/lib/flickrie/media.rb

@@ -45,13 +45,7 @@ module Flickrie
     end
 
     def geo_permissions
-      if @info['geoperms']
-        Visibility.new \
-          *[@info['geoperms']['ispublic'],
-            @info['geoperms']['isfriend'],
-            @info['geoperms']['isfamily'],
-            @info['geoperms']['iscontact']]
-      end
+      Visibility.new(@info['geoperms']) if @info['geoperms']
     end
 
     def license
@@ -86,12 +80,7 @@ module Flickrie
     end
 
     def visibility
-      if @info['visibility']
-        Visibility.new \
-          *[@info['visibility']['ispublic'],
-            @info['visibility']['isfriend'],
-            @info['visibility']['isfamily']]
-      end
+      Visibility.new(@info['visibility']) if @info['visibility']
     end
 
     def primary?; @info['isprimary'].to_i == 1 if @info['isprimary'] end
@@ -122,10 +111,13 @@ module Flickrie
       @info['notes']['note'].map { |hash| Note.new(hash) } if @info['notes']
     end
 
+    def [](key)
+      @info[key]
+    end
+
     def get_info(info = nil)
       info ||= Flickrie.client.get_media_info(id).body['photo']
 
-      # Fixes
       info['title'] = info['title']['_content']
       info['description'] = info['description']['_content']
       info['comments_count'] = info.delete('comments')['_content']
@@ -151,7 +143,7 @@ module Flickrie
       @info['usage'] ||= {}
     end
 
-    module ClassMethods
+    module ClassMethods # :nodoc:
       def from_set(hash)
         hash['photo'].map do |info|
           info['owner'] = {
@@ -253,58 +245,3 @@ module Flickrie
     end
   end
 end
-
-__END__
-
-
-{
-  "id"=>"6923154272",
-  "secret"=>"5519fab554",
-  "server"=>"5279",
-  "farm"=>6,
-  "dateuploaded"=>"1334189525",
-  "isfavorite"=>0,
-  "license"=>"0",
-  "safety_level"=>"0",
-  "rotation"=>0,
-  "owner"=>
-   {"nsid"=>"67131352@N04",
-    "username"=>"Janko Marohnić",
-    "realname"=>"",
-    "location"=>"",
-    "iconserver"=>"0",
-    "iconfarm"=>0},
-  "title"=>{"_content"=>"David Belle - Canon commercial"},
-  "description"=>{"_content"=>""},
-  "visibility"=>{"ispublic"=>1, "isfriend"=>0, "isfamily"=>0},
-  "dates"=>
-   {"posted"=>"1334189525",
-    "taken"=>"2012-04-11 17:12:05",
-    "takengranularity"=>"0",
-    "lastupdate"=>"1334259651"},
-  "views"=>"1",
-  "editability"=>{"cancomment"=>0, "canaddmeta"=>0},
-  "publiceditability"=>{"cancomment"=>1, "canaddmeta"=>0},
-  "usage"=>{"candownload"=>1, "canblog"=>0, "canprint"=>0, "canshare"=>0},
-  "comments"=>{"_content"=>"0"},
-  "notes"=>{"note"=>[]},
-  "people"=>{"haspeople"=>0},
-  "tags"=>
-   {"tag"=>
-     [{"id"=>"67099213-6923154272-471",
-       "author"=>"67131352@N04",
-       "raw"=>"David",
-       "_content"=>"david",
-       "machine_tag"=>0},
-      {"id"=>"67099213-6923154272-18012",
-       "author"=>"67131352@N04",
-       "raw"=>"Belle",
-       "_content"=>"belle",
-       "machine_tag"=>0}]},
-  "location"=> {...}
-  "geoperms"=>{"ispublic"=>1, "iscontact"=>0, "isfriend"=>0, "isfamily"=>0},
-  "urls"=>
-   {"url"=>
-     [{"type"=>"photopage",
-       "_content"=>"http://www.flickr.com/photos/67131352@N04/6923154272/"}]},
-}

data/lib/flickrie/media_count.rb

@@ -20,6 +20,10 @@ module Flickrie
       dates.first..dates.last
     end
 
+    def [](key)
+      @info[key]
+    end
+
     def initialize(info, params)
       @info = info
       @dates_kind = (params[:dates].nil? ? "mysql timestamp" : "unix timestamp")

data/lib/flickrie/oauth.rb

@@ -6,6 +6,7 @@ module Flickrie
     URL = 'http://www.flickr.com/services/oauth'.freeze
     NO_CALLBACK = 'oob'.freeze
 
+    # :nodoc:
     def self.new_connection(additional_oauth_params = {})
       oauth_params = {
         :consumer_key => Flickrie.api_key,
@@ -22,7 +23,7 @@ module Flickrie
       end
     end
 
-    class StatusCheck < Faraday::Response::Middleware
+    class StatusCheck < Faraday::Response::Middleware # :nodoc:
       def on_complete(env)
         if env[:status] != 200
           raise Error, env[:body]['oauth_problem'].gsub('_', ' ').capitalize
@@ -33,13 +34,14 @@ module Flickrie
     class Error < StandardError
     end
 
-    class ParseResponseParams < FaradayMiddleware::ResponseMiddleware
+    class ParseResponseParams < FaradayMiddleware::ResponseMiddleware # :nodoc:
       define_parser do |body|
         params_array = body.split('&').map { |param| param.split('=') }
         Hash[*params_array.flatten]
       end
     end
 
+    # :doc:
     def self.get_request_token(options = {})
       connection = new_connection
 
@@ -62,7 +64,7 @@ module Flickrie
       AccessToken.from_response(response.body)
     end
 
-    module Token
+    module Token # :nodoc:
       def from_response(body)
         new(body['oauth_token'], body['oauth_token_secret'])
       end

data/lib/flickrie/set.rb

@@ -25,6 +25,7 @@ module Flickrie
 
     def can_comment?; @info['can_comment'].to_i == 1 if @info['can_comment'] end
 
+    #--
     # TODO: Figure out what this is
     def needs_interstitial?; @info['needs_interstitial'].to_i == 1 end
     def visibility_can_see_set?; @info['visibility_can_see_set'].to_i == 1 end
@@ -34,6 +35,10 @@ module Flickrie
 
     def url; "http://www.flickr.com/photos/#{owner.nsid}/sets/#{id}" end
 
+    def [](key)
+      @info[key]
+    end
+
     def get_info(info = nil)
       info ||= Flickrie.client.get_set_info(id).body['photoset']
       info['title'] = info['title']['_content']
@@ -66,24 +71,3 @@ module Flickrie
     end
   end
 end
-
-__END__
-
-{
-  "id"=>"72157629443464020",
-  "primary"=>"6913731566",
-  "secret"=>"23879c079a",
-  "server"=>"7130",
-  "farm"=>8,
-  "photos"=>"1",
-  "videos"=>0,
-  "title"=>{"_content"=>"Bla"},
-  "description"=>{"_content"=>""},
-  "needs_interstitial"=>0,
-  "visibility_can_see_set"=>1,
-  "count_views"=>"0",
-  "count_comments"=>"0",
-  "can_comment"=>0,
-  "date_create"=>"1334331151",
-  "date_update"=>"1334331155
-}

data/lib/flickrie/upload_client.rb

@@ -28,10 +28,12 @@ module Flickrie
     end
   end
 
-  class UploadStatusCheck < Faraday::Response::Middleware
+  class UploadStatusCheck < Faraday::Response::Middleware # :nodoc:
     def on_complete(env)
       if env[:body]['rsp']['stat'] != 'ok'
-        raise Error, env[:body]['rsp']['err']['msg']
+        error = env[:body]['rsp']['err']
+        raise Error.new(error['msg'], error['code']),
+          error['msg']
       end
     end
   end

data/lib/flickrie/user.rb

@@ -50,11 +50,14 @@ module Flickrie
       @info['ispro'].to_i == 1 if @info['ispro']
     end
 
+    def [](key)
+      @info[key]
+    end
+
     def get_info(info = nil)
       info ||= Flickrie.client.get_user_info(nsid).body['person']
       @info.update(info)
 
-      # Fixes
       %w[username realname location description profileurl
          mobileurl photosurl].each do |attribute|
         @info[attribute] = @info[attribute]['_content']

data/lib/flickrie/version.rb

@@ -1,3 +1,3 @@
 module Flickrie
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
 end

data/lib/flickrie/video.rb

@@ -47,16 +47,3 @@ module Flickrie
     end
   end
 end
-
-__END__
-
-{
-  ...
-  "video"=>
-   {"ready"=>1,
-    "failed"=>0,
-    "pending"=>0,
-    "duration"=>"34",
-    "width"=>"480",
-    "height"=>"360"}
-}

data/test/error_test.rb

@@ -0,0 +1,20 @@
+class ErrorTest < Test::Unit::TestCase
+  def test_code
+    VCR.use_cassette 'error/code' do
+      begin
+        Flickrie.api_key = nil
+        Flickrie.client.get_licenses
+      rescue Flickrie::Error => error
+        assert_equal 100, error.code
+      end
+
+      begin
+        Flickrie.api_key = nil
+        Flickrie.upload_client.upload \
+          File.expand_path(File.join(File.dirname(__FILE__), 'photo.jpg'))
+      rescue Flickrie::Error => error
+        assert_equal 100, error.code
+      end
+    end
+  end
+end

data/test/instance_test.rb

@@ -1,21 +1,20 @@
-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']
+  def test_calling_api_methods
+    VCR.use_cassette 'instance/calling_api_methods' do
+      Flickrie.access_token = nil
+      Flickrie.access_secret = nil
 
-    flickr = Flickrie::Instance.new \
-      ENV['FLICKR_ACCESS_TOKEN'], ENV['FLICKR_ACCESS_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)
+      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
+      tag = photo.tags.find { |tag| tag.content == "janko" }
+      assert_not_nil tag
 
-    flickr.remove_photo_tag tag.id
+      flickr.remove_photo_tag tag.id
+    end
   end
 end