flickr-objects 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eebc705fe752afa94151b9a736292d266f37b15a
-  data.tar.gz: 70de81c78b4a5bdb9e575aa96b2aa5d069523ba8
+  metadata.gz: 86c3505e2229c1d398d2993def2dc600aa553479
+  data.tar.gz: b3d7201ba2d5045c32170346dbd6488124f1b61c
 SHA512:
-  metadata.gz: 4003856d98c98ddf1b9336b51452c846134d991b9e9cf230f1e4b75830cec0b60d354c2408db07a207133cef37438e8b351d7a9bc27bba09f7a1c52236047580
-  data.tar.gz: 4e4698dbc564b5efb8b496c48bccc6216239ae711b22ee4268216c25af2998c3449b3150e783db4817e3c105612d21fbade3bcff4df434c2fa8cb31a727c0bf4
+  metadata.gz: 6dbee233ae370d5646d4774f91e4555a294442abebad859b4c21b3d5516f9ff558e71f014934abdc6d5b0380f7e04d704ee1a30f0dd7820b6d6b9b1e28f18dfc
+  data.tar.gz: ffb3356c91cb905667b10465250e9f72a22edfa9a34a06cdadb0522702330eb68fa6ca3a54746693616cdab560e9745e518f1de3a4dd291a377c1f20d6f55e2b

data/README.md

@@ -2,9 +2,9 @@
 
 This gem is an object-oriented wrapper for the [Flickr API](http://flickr.com/api).
 
-- Web page: [http://janko-m.github.com/flickr-objects/](http://janko-m.github.com/flickr-objects/)
-- Home page: [https://github.com/janko-m/flickr-objects](https://github.com/janko-m/flickr-objects)
-- API Documentation: [http://rubydoc.info/gems/flickr-objects/](http://rubydoc.info/gems/flickr-objects/)
+- Web page: [http://janko-m.github.com/flickr-objects](http://janko-m.github.com/flickr-objects)
+- Source code: [https://github.com/janko-m/flickr-objects](https://github.com/janko-m/flickr-objects)
+- API Documentation: [http://rubydoc.info/github/janko-m/flickr-objects/master/frames](http://rubydoc.info/github/janko-m/flickr-objects/master/frames)
 
 ## Installation and setup
 
@@ -26,8 +26,8 @@ end
 If you don't have them yet, you can apply for them
 [here](http://www.flickr.com/services/apps/create/apply).
 
-For list of possible configuration options, take a look at
-[`Flickr::Configuration`](http://rubydoc.info/gems/flickr-objects/Flickr/Configuration).
+For list of possible configuration options, see
+[`Flickr::Configuration`](http://rubydoc.info/github/janko-m/flickr-objects/master/Flickr/Configuration).
 
 ## Usage
 
@@ -38,8 +38,8 @@ Flickr.photos.search(...)   # flickr.photos.search
 Flickr.person.get_sets(...) # flickr.photosets.getList
 ```
 
-For the list of all API methods (and their related Flickr's methods), see the
-[`Flickr::Api`](http://rubydoc.info/gems/flickr-objects/Flickr/Api) module.
+For the list of all API methods (and their related Flickr's methods), see
+[`Flickr::Api`](http://rubydoc.info/github/janko-m/flickr-objects/master/Flickr/Api).
 These methods are included to the `Flickr` module.
 
 Example:
@@ -61,10 +61,10 @@ set.photos_count #=> 40
 Few notes here:
 
 - flickr-objects distinguishes **instance** from **class** API methods. So,
-  `Flickr.photos.search` is a class API method. And `Flickr.people.get_sets`
+  `Flickr.photos.search` is a **class** API method. And `Flickr.people.get_sets`
   is by its nature an **instance** API method, because we're finding sets
-  *from a person*; in that case we can call `#get_sets` on an instance of
-  person (so that our code looks better).
+  *from a person*; in that case it's nicer to call `#get_sets` on an instance of
+  person.
 - Flickr objects can always be instantiated with `Flickr.<objects>.find(id)`
   (in the above example we did `Flickr.people.find(id)`).
 
@@ -84,8 +84,8 @@ the argument list:
 Flickr.people.find_by_email("janko.marohnic@gmail.com")
 ```
 
-Of course, all parameters are documented:
-[`Flickr::Api::Person#find_by_email`](http://rubydoc.info/gems/flickr-objects/Flickr/Api/Person#find_by_email-instance_method)
+These arguments are documented:
+[`Flickr::Api::Person#find_by_email`](http://rubydoc.info/github/janko-m/flickr-objects/master/Flickr/Api/Person#find_by_email-instance_method).
 
 ## Sizes
 
@@ -103,7 +103,7 @@ photo.width      #=> 500
 ```
 
 It is important here that you pass `sizes: true` to `Flickr::Person#public_photos`.
-So, in your (Rails) application, one could use it like this:
+So, in your (Rails) application, you could use it like this:
 
 ```ruby
 class PhotosController < ApplicationController
@@ -119,7 +119,7 @@ end
 <% end %>
 ```
 
-To find out more, see [`Flickr::Object::Photo`](http://rubydoc.info/gems/flickr-objects/Flickr/Object/Photo).
+To find out more, see [`Flickr::Object::Photo`](http://rubydoc.info/github/janko-m/flickr-objects/master/Flickr/Object/Photo).
 
 ## Authentication
 
@@ -133,8 +133,8 @@ flickr.test_login #=> {"id" => "78733179@N04", "username" => ...}
 flickr.people.find("78733179@N04").get_photos #=> [#<Flickr::Photo ...>, #<Flickr::Photo, ...>, ...]
 ```
 
-For details on how to authenticate, i.e. obtain the access token, see
-[`Flickr::OAuth`](http://rubydoc.info/gems/flickr-objects/Flickr/OAuth).
+For details on how to authenticate the user, that is, obtain his access token, see
+[`Flickr::OAuth`](http://rubydoc.info/github/janko-m/flickr-objects/master/Flickr/OAuth).
 
 If you want, you can also assign the access token globally in your configuration.
 
@@ -155,7 +155,7 @@ photo = Flickr.photos.find(photo_id).get_info!
 photo.title #=> "Dandelions"
 ```
 
-See [`Flickr.upload`](http://rubydoc.info/gems/flickr-objects/Flickr/Api/General#upload-instance_method)
+See [`Flickr.upload`](http://rubydoc.info/github/janko-m/flickr-objects/master/Flickr/Api/General#upload-instance_method).
 
 ## Few words
 

data/lib/flickr/api/abstract/params_processor.rb

@@ -6,6 +6,8 @@ module Flickr
       # Does processing of parameters passed to API requests, to enable nicer
       # syntax.
       #
+      # @private
+      #
       class ParamsProcessor
 
         attr_reader :params
@@ -46,19 +48,28 @@ module Flickr
         end
 
         def add_sizes?(flickr_method)
-          [ "photos.getContactsPhotos",
-            "photos.search",
+          [ "favorites.getPublicList",
+            "favorites.getList",
+            "galleries.getPhotos",
+            "groups.pools.getPhotos",
+            "interestingness.getList",
+            "people.getPhotos",
+            "people.getPhotosOf",
+            "panda.getPhotos",
+            "people.getPublicPhotos",
+            "photos.comments.getRecentForContacts",
+            "photos.geo.getLocation",
+            "photos.geo.photosForLocation",
+            "photos.getContactsPhotos",
+            "photos.getContactsPublicPhotos",
             "photos.getNotInSet",
             "photos.getRecent",
-            "photos.getUntagged",
             "photos.getWithGeoData",
+            "photos.getUntagged",
             "photos.getWithoutGeoData",
-            "photos.RecentlyUpdated",
-            "photosets.getPhotos",
-            "people.getPhotos",
-            "people.getPhotosOf",
-            "people.getPublicPhotos",
-            "people.getContactsPublicPhotos" ].include?(flickr_method)
+            "photos.search",
+            "photos.recentlyUpdated",
+            "photosets.getPhotos" ].include?(flickr_method)
         end
 
       end

data/lib/flickr/api/abstract.rb

@@ -5,6 +5,8 @@ module Flickr
     # This class abstracts the interface for communication with the Flickr API.
     #
     # @see Flickr::ApiError
+    # @see Flickr::OAuthError
+    # @see Flickr::TimeoutError
     #
     class Abstract
 

data/lib/flickr/api/person.rb

@@ -45,6 +45,8 @@ module Flickr
       ##
       # @param person_id [String]
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.people.getPhotos](http://www.flickr.com/services/api/flickr.people.getPhotos.html)
       #
@@ -56,6 +58,8 @@ module Flickr
       ##
       # @param person_id [String]
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.people.getPhotosOf](http://www.flickr.com/services/api/flickr.people.getPhotosOf.html)
       #
@@ -67,6 +71,8 @@ module Flickr
       ##
       # @param person_id [String]
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.people.getPublicPhotos](http://www.flickr.com/services/api/flickr.people.getPublicPhotos.html)
       #
@@ -78,6 +84,8 @@ module Flickr
       ##
       # @param person_id [String]
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.getContactsPublicPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPublicPhotos.html)
       #

data/lib/flickr/api/photo.rb

@@ -5,6 +5,8 @@ module Flickr
 
       ##
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.search](http://www.flickr.com/services/api/flickr.photos.search.html)
       #
@@ -15,6 +17,8 @@ module Flickr
 
       ##
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.getContactsPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPhotos.html)
       #
@@ -25,6 +29,8 @@ module Flickr
 
       ##
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.getNotInSet](http://www.flickr.com/services/api/flickr.photos.getNotInSet.html)
       #
@@ -35,6 +41,8 @@ module Flickr
 
       ##
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.getRecent](http://www.flickr.com/services/api/flickr.photos.getRecent.html)
       #
@@ -45,6 +53,20 @@ module Flickr
 
       ##
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.interestingness.getList](www.flickr.com/services/api/flickr.interestingness.getList.html)
+      #
+      def get_interesting(params = {})
+        response = get "interestingness.getList", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.getUntagged](http://www.flickr.com/services/api/flickr.photos.getUntagged.html)
       #
@@ -55,6 +77,8 @@ module Flickr
 
       ##
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.getWithGeoData](http://www.flickr.com/services/api/flickr.photos.getWithGeoData.html)
       #
@@ -65,6 +89,8 @@ module Flickr
 
       ##
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.getWithoutGeoData](http://www.flickr.com/services/api/flickr.photos.getWithoutGeoData.html)
       #
@@ -75,6 +101,8 @@ module Flickr
 
       ##
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photos.RecentlyUpdated](http://www.flickr.com/services/api/flickr.photos.RecentlyUpdated.html)
       #

data/lib/flickr/api/set.rb

@@ -55,6 +55,8 @@ module Flickr
       ##
       # @param set_id [String]
       # @param params [Hash] See documentation below
+      # @option params [Boolean, Array<String>] :sizes For all sizes use `true`, for specific ones
+      #   chuck them into an array (e.g. `["Square 75", "Medium 500"]`).
       # @return [Flickr::Object::List<Flickr::Object::Photo>]
       # @docs [flickr.photosets.getPhotos](http://www.flickr.com/services/api/flickr.photosets.getPhotos.html)
       #

data/lib/flickr/version.rb

@@ -1,5 +1,5 @@
 module Flickr
 
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flickr-objects
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -258,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: This gem is an object-oriented wrapper for the Flickr API.