flickrie 1.6.0 → 1.6.1

data/lib/flickrie/callable.rb

@@ -8,26 +8,26 @@ module Flickrie
     # This is for manual use (for example, if I haven't covered something yet, and you really need it).
     # Here's an example:
     #
-    #     response = Flickrie.client.get "flickr.photos.getInfo", :photo_id => 8423943
+    #     response = Flickrie.client.get "flickr.photos.getInfo", photo_id: 8423943
     #     response.body['photo']['id']          # => 8423943
     #     response.body['photo']['description'] # => "..."
     #
-    #     Flickrie.client.post "flickr.photos.licenses.setLicense", :photo_id => 1241497, :license_id => 2
+    #     Flickrie.client.post "flickr.photos.licenses.setLicense", photo_id: 1241497, license_id: 2
     #
     # For the full list of available API methods, see [this page](http://www.flickr.com/services/api/).
     #
     # @return [HTTP response] A Faraday HTTP response
     def client
       params = {
-        :url => 'http://api.flickr.com/services/rest',
-        :params => {
-          :format => 'json',
-          :nojsoncallback => '1',
-          :api_key => api_key
+        url: 'https://api.flickr.com/services/rest',
+        params: {
+          format: 'json',
+          nojsoncallback: '1',
+          api_key: api_key
         },
-        :request => {
-          :open_timeout => open_timeout || DEFAULTS[:open_timeout],
-          :timeout => timeout || DEFAULTS[:timeout]
+        request: {
+          open_timeout: open_timeout || DEFAULTS[:open_timeout],
+          timeout: timeout || DEFAULTS[:timeout]
         }
       }
 
@@ -35,10 +35,10 @@ module Flickrie
         Client.new(params) do |b|
           b.use Middleware::Retry
           b.use FaradayMiddleware::OAuth,
-            :consumer_key => api_key,
-            :consumer_secret => shared_secret,
-            :token => access_token,
-            :token_secret => access_secret
+            consumer_key: api_key,
+            consumer_secret: shared_secret,
+            token: access_token,
+            token_secret: access_secret
 
           b.use Middleware::FixFlickrData
           b.use Middleware::StatusCheck
@@ -51,9 +51,9 @@ module Flickrie
 
     def upload_client
       params = {
-        :url => 'http://api.flickr.com/services',
-        :request => {
-          :open_timeout => open_timeout || DEFAULTS[:open_timeout]
+        url: 'https://api.flickr.com/services',
+        request: {
+          open_timeout: open_timeout || DEFAULTS[:open_timeout]
         }
       }
 
@@ -61,10 +61,10 @@ module Flickrie
         UploadClient.new(params) do |b|
           b.use Middleware::Retry
           b.use FaradayMiddleware::OAuth,
-            :consumer_key => api_key,
-            :consumer_secret => shared_secret,
-            :token => access_token,
-            :token_secret => access_secret
+            consumer_key: api_key,
+            consumer_secret: shared_secret,
+            token: access_token,
+            token_secret: access_secret
           b.request :multipart
 
           b.use Middleware::UploadStatusCheck

data/lib/flickrie/client.rb

@@ -2,11 +2,9 @@ require 'faraday'
 
 module Flickrie
   class Client < Faraday::Connection
-    # @!method get(method, params = {})
-    # @!method post(method, params = {})
     [:get, :post].each do |http_method|
       define_method(http_method) do |flickr_method, params = {}|
-        # (:include_sizes => true) --> (:extras => "url_sq,url_q,url_s,...")
+        # (include_sizes: true) --> (extras: "url_sq,url_q,url_s,...")
         if params.delete(:include_sizes)
           urls = Photo::FLICKR_SIZES.values.map { |s| "url_#{s}" }.join(',')
           params[:extras] = [params[:extras], urls].compact.join(',')
@@ -19,263 +17,22 @@ module Flickrie
       end
     end
 
-    # people
-    def find_user_by_email(email, params = {})
-      get 'flickr.people.findByEmail',
-        {:find_email => email}.merge(params)
-    end
-
-    def find_user_by_username(username, params = {})
-      get 'flickr.people.findByUsername',
-        {:username => username}.merge(params)
-    end
-
-    def get_user_info(nsid, params = {})
-      get 'flickr.people.getInfo',
-        {:user_id => nsid}.merge(params)
-    end
-
-    def media_from_user(nsid, params = {})
-      get 'flickr.people.getPhotos',
-        ensure_media({:user_id => nsid}.merge(params))
-    end
-
-    def media_of_user(nsid, params = {})
-      get 'flickr.people.getPhotosOf',
-        ensure_media({:user_id => nsid}.merge(params))
-    end
-
-    def public_media_from_user(nsid, params = {})
-      get 'flickr.people.getPublicPhotos',
-        ensure_media({:user_id => nsid}.merge(params))
-    end
-
-    def get_upload_status(params = {})
-      get 'flickr.people.getUploadStatus', params
-    end
-
-    # photos
-    def add_media_tags(media_id, tags, params = {})
-      post 'flickr.photos.addTags',
-        {:photo_id => media_id, :tags => tags}.merge(params)
-    end
-
-    def delete_media(media_id, params = {})
-      post 'flickr.photos.delete',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def media_from_contacts(params = {})
-      get 'flickr.photos.getContactsPhotos', ensure_media(params)
-    end
-
-    def public_media_from_user_contacts(nsid, params = {})
-      get 'flickr.photos.getContactsPublicPhotos',
-        ensure_media({:user_id => nsid}.merge(params))
-    end
-
-    def get_media_context(media_id, params = {})
-      get 'flickr.photos.getContext',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def get_media_counts(params = {})
-      get 'flickr.photos.getCounts', ensure_utc(params)
-    end
-
-    def get_media_exif(media_id, params = {})
-      get 'flickr.photos.getExif',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def get_media_favorites(media_id, params = {})
-      get 'flickr.photos.getFavorites',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def get_media_info(media_id, params = {})
-      get 'flickr.photos.getInfo',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def media_not_in_set(params = {})
-      get 'flickr.photos.getNotInSet', ensure_media(params)
-    end
-
-    def get_media_permissions(media_id, params = {})
-      get 'flickr.photos.getPerms',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def get_recent_media(params = {})
-      get 'flickr.photos.getRecent', ensure_media(params)
-    end
-
-    def get_media_sizes(media_id, params = {})
-      get 'flickr.photos.getSizes',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def get_untagged_media(params = {})
-      get 'flickr.photos.getUntagged', ensure_media(params)
-    end
-
-    def get_media_with_geo_data(params = {})
-      get 'flickr.photos.getWithGeoData', ensure_media(params)
-    end
-
-    def get_media_without_geo_data(params = {})
-      get 'flickr.photos.getWithoutGeoData', ensure_media(params)
-    end
-
-    def recently_updated_media(params = {})
-      get 'flickr.photos.recentlyUpdated', ensure_media(params)
-    end
-
-    def remove_media_tag(tag_id, params = {})
-      post 'flickr.photos.removeTag',
-        {:tag_id => tag_id}.merge(params)
-    end
-
-    def search_media(params = {})
-      get 'flickr.photos.search', ensure_media(params)
-    end
-
-    def set_media_content_type(media_id, content_type, params = {})
-      post 'flickr.photos.setContentType',
-        {:photo_id => media_id, :content_type => content_type}.merge(params)
-    end
-
-    def set_media_dates(media_id, params = {})
-      post 'flickr.photos.setDates',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def set_media_meta(media_id, params = {})
-      post 'flickr.photos.setMeta',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def set_media_permissions(media_id, params = {})
-      post 'flickr.photos.setPerms',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def set_media_safety_level(media_id, params = {})
-      post 'flickr.photos.setSafetyLevel',
-        {:photo_id => media_id}.merge(params)
-    end
-
-    def set_media_tags(media_id, tags, params = {})
-      post 'flickr.photos.setTags',
-        {:photo_id => media_id, :tags => tags}.merge(params)
-    end
-
-    # photos.upload
-    def check_upload_tickets(tickets, params = {})
-      get 'flickr.photos.upload.checkTickets',
-        {:tickets => tickets}.merge(params)
-    end
-
-    # photos.licenses
-    def get_licenses(params = {})
-      get 'flickr.photos.licenses.getInfo', params
-    end
-
-    def set_media_license(media_id, license_id, params = {})
-      post 'flickr.photos.licenses.setLicense',
-        {:photo_id => media_id, :license_id => license_id}.merge(params)
-    end
-
-    # photos.transform
-    def rotate_media(media_id, degrees, params = {})
-      post 'flickr.photos.transform.rotate',
-        {:photo_id => media_id, :degrees => degrees}.merge(params)
-    end
-
-    # photosets
-    def add_media_to_set(set_id, media_id, params = {})
-      post 'flickr.photosets.addPhoto',
-        {:photoset_id => set_id, :photo_id => media_id}.merge(params)
-    end
-
-    def create_set(params = {})
-      post 'flickr.photosets.create', params
-    end
-
-    def delete_set(set_id, params = {})
-      post 'flickr.photosets.delete', {:photoset_id => set_id}.merge(params)
-    end
-
-    def edit_set_metadata(set_id, params = {})
-      post 'flickr.photosets.editMeta', {:photoset_id => set_id}.merge(params)
-    end
-
-    def edit_set_photos(set_id, params = {})
-      post 'flickr.photosets.editPhotos',
-        {:photoset_id => set_id}.merge(params)
-    end
-
-    def get_set_context(set_id, media_id, params = {})
-      get 'flickr.photosets.getContext',
-        {:photoset_id => set_id, :photo_id => media_id}.merge(params)
-    end
-
-    def get_set_info(set_id, params = {})
-      get 'flickr.photosets.getInfo',
-        {:photoset_id => set_id}.merge(params)
-    end
-
-    def sets_from_user(nsid, params = {})
-      get 'flickr.photosets.getList',
-        {:user_id => nsid}.merge(params)
-    end
-
-    def media_from_set(set_id, params = {})
-      get 'flickr.photosets.getPhotos',
-        ensure_media({:photoset_id => set_id}.merge(params))
-    end
-
-    def order_sets(set_ids, params = {})
-      post 'flickr.photosets.orderSets', {:photoset_ids => set_ids}.merge(params)
-    end
-
-    def remove_media_from_set(set_id, media_ids, params = {})
-      post 'flickr.photosets.removePhotos',
-        {:photoset_id => set_id, :photo_ids => media_ids}.merge(params)
-    end
-
-    def reorder_media_in_set(set_id, media_ids, params = {})
-      post 'flickr.photosets.reorderPhotos',
-        {:photoset_id => set_id, :photo_ids => media_ids}.merge(params)
-    end
-
-    def set_primary_media_to_set(set_id, media_id, params = {})
-      post 'flickr.photosets.setPrimaryPhoto',
-        {:photoset_id => set_id, :photo_id => media_id}.merge(params)
-    end
-
-    # test
-    def test_login(params = {})
-      get 'flickr.test.login', params
-    end
-
-    private
-
-    def ensure_media(params)
-      params.dup.tap do |dup_params|
-        dup_params[:extras] = [dup_params[:extras], 'media'].compact.join(',')
-      end
-    end
-
-    def ensure_utc(params)
-      params.dup.tap do |hash|
-        if hash[:taken_dates].is_a?(String)
-          hash[:taken_dates] = hash[:taken_dates].split(',').
-            map { |date| DateTime.parse(date) }.
-            map(&:to_time).map(&:getutc).join(',')
+    def method_missing(name, *args, &block)
+      [
+        name.to_s.sub(/media|photos?|videos?/, "(photos|videos|media)"),
+        name.to_s.sub(/media|photos?|videos?/, "(photo|video|media)"),
+        name.to_s.sub(/media|photos?|videos?/, "(photo|video)")
+      ].
+        each do |method_name|
+          if flickr_method = FLICKR_API_METHODS.invert[method_name]
+            http_method, params = methods[flickr_method]
+            return send(http_method, flickr_method, params.call(*args))
+          end
         end
-      end
+
+      super
     end
   end
 end
+
+require "flickrie/client/methods"

data/lib/flickrie/client/methods.rb

@@ -0,0 +1,89 @@
+module Flickrie
+  class Client
+    def methods
+      @methods ||= {
+        "flickr.people.findByEmail"                   => [:get, ->(email, params = {}) { {find_email: email}.merge(params) }],
+        "flickr.people.findByUsername"                => [:get, ->(username, params = {}) { {username: username}.merge(params) }],
+        "flickr.people.getInfo"                       => [:get, ->(nsid, params = {}) { {user_id: nsid}.merge(params) }],
+        "flickr.people.getPhotos"                     => [:get, ->(nsid, params = {}) { ensure_media({user_id: nsid}.merge(params)) }],
+        "flickr.people.getPhotosOf"                   => [:get, ->(nsid, params = {}) { ensure_media({user_id: nsid}.merge(params)) }],
+        "flickr.people.getPublicPhotos"               => [:get, ->(nsid, params = {}) { ensure_media({user_id: nsid}.merge(params)) }],
+        "flickr.people.getUploadStatus"               => [:get, ->(params = {}) { params }],
+
+        "flickr.photos.addTags"                       => [:post, ->(media_id, tags, params = {}) { {photo_id: media_id, tags: tags}.merge(params) }],
+        "flickr.photos.delete"                        => [:post, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.getContactsPhotos"             => [:get, ->(params = {}) { ensure_media(params) }],
+        "flickr.photos.getContactsPublicPhotos"       => [:get, ->(nsid, params = {}) { ensure_media({user_id: nsid}.merge(params)) }],
+        "flickr.photos.getContext"                    => [:get, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.getCounts"                     => [:get, ->(params = {}) { ensure_utc(params) }],
+        "flickr.photos.getExif"                       => [:get, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.getFavorites"                  => [:get, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.getInfo"                       => [:get, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.getNotInSet"                   => [:get, ->(params = {}) { ensure_media(params) }],
+        "flickr.photos.getPerms"                      => [:get, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.getRecent"                     => [:get, ->(params = {}) { ensure_media(params) }],
+        "flickr.photos.getSizes"                      => [:get, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.getUntagged"                   => [:get, ->(params = {}) { ensure_media(params) }],
+        "flickr.photos.getWithGeoData"                => [:get, ->(params = {}) { ensure_media(params) }],
+        "flickr.photos.getWithoutGeoData"             => [:get, ->(params = {}) { ensure_media(params) }],
+        "flickr.photos.recentlyUpdated"               => [:get, ->(params = {}) { ensure_media(params) }],
+        "flickr.photos.removeTag"                     => [:post, ->(tag_id, params = {}) { {tag_id: tag_id}.merge(params) }],
+        "flickr.photos.search"                        => [:get, ->(params = {}) { ensure_media(params) }],
+        "flickr.photos.setContentType"                => [:post, ->(media_id, content_type, params = {}) { {photo_id: media_id, content_type: content_type}.merge(params) }],
+        "flickr.photos.setDates"                      => [:post, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.setMeta"                       => [:post, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.setPerms"                      => [:post, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.setSafetyLevel"                => [:post, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.setTags"                       => [:post, ->(media_id, tags, params = {}) { {photo_id: media_id, tags: tags}.merge(params) }],
+
+        "flickr.photos.comments.addComment"           => [:post, ->(media_id, comment, params = {}) { {photo_id: media_id, comment_text: comment}.merge(params) }],
+        "flickr.photos.comments.deleteComment"        => [:post, ->(comment_id, params = {}) { {comment_id: comment_id}.merge(params) }],
+        "flickr.photos.comments.editComment"          => [:post, ->(comment_id, comment, params = {}) { {comment_id: comment_id, comment_text: comment}.merge(params) }],
+        "flickr.photos.comments.getList"              => [:get, ->(media_id, params = {}) { {photo_id: media_id}.merge(params) }],
+        "flickr.photos.comments.getRecentForContacts" => [:get, ->(params = {}) { ensure_media(params) }],
+
+        "flickr.photos.upload.checkTickets"           => [:get, ->(tickets, params = {}) { {tickets: tickets}.merge(params) }],
+
+        "flickr.photos.licenses.getInfo"              => [:get, ->(params = {}) { params }],
+        "flickr.photos.licenses.setLicense"           => [:post, ->(media_id, license_id, params = {}) { {photo_id: media_id, license_id: license_id}.merge(params) }],
+
+        "flickr.photos.transform.rotate"              => [:post, ->(media_id, degrees, params = {}) { {photo_id: media_id, degrees: degrees}.merge(params) }],
+
+        "flickr.photosets.addPhoto"                   => [:post, ->(set_id, media_id, params = {}) { {photoset_id: set_id, photo_id: media_id}.merge(params) }],
+        "flickr.photosets.create"                     => [:post, ->(params = {}) { params }],
+        "flickr.photosets.delete"                     => [:post, ->(set_id, params = {}) { {photoset_id: set_id}.merge(params) }],
+        "flickr.photosets.editMeta"                   => [:post, ->(set_id, params = {}) { {photoset_id: set_id}.merge(params) }],
+        "flickr.photosets.editPhotos"                 => [:post, ->(set_id, params = {}) { {photoset_id: set_id}.merge(params) }],
+        "flickr.photosets.getContext"                 => [:get, ->(set_id, media_id, params = {}) { {photoset_id: set_id, photo_id: media_id}.merge(params) }],
+        "flickr.photosets.getInfo"                    => [:get, ->(set_id, params = {}) { {photoset_id: set_id}.merge(params) }],
+        "flickr.photosets.getList"                    => [:get, ->(nsid, params = {}) { {user_id: nsid}.merge(params) }],
+        "flickr.photosets.getPhotos"                  => [:get, ->(set_id, params = {}) { ensure_media({photoset_id: set_id}.merge(params)) }],
+        "flickr.photosets.orderSets"                  => [:post, ->(set_ids, params = {}) { {photoset_ids: set_ids}.merge(params) }],
+        "flickr.photosets.removePhotos"               => [:post, ->(set_id, media_ids, params = {}) { {photoset_id: set_id, photo_ids: media_ids}.merge(params) }],
+        "flickr.photosets.reorderPhotos"              => [:post, ->(set_id, media_ids, params = {}) { {photoset_id: set_id, photo_ids: media_ids}.merge(params) }],
+        "flickr.photosets.setPrimaryPhoto"            => [:post, ->(set_id, media_id, params = {}) { {photoset_id: set_id, photo_id: media_id}.merge(params) }],
+        "flickr.reflection.getMethods"                => [:get, ->(params = {}) { params }],
+
+        "flickr.test.login"                           => [:get, ->(params = {}) { params }],
+      }
+    end
+
+    private
+
+    def ensure_media(params)
+      params.dup.tap do |dup_params|
+        dup_params[:extras] = [dup_params[:extras], 'media'].compact.join(',')
+      end
+    end
+
+    def ensure_utc(params)
+      params.dup.tap do |hash|
+        if hash[:taken_dates].is_a?(String)
+          hash[:taken_dates] = hash[:taken_dates].split(',').
+            map { |date| DateTime.parse(date) }.
+            map(&:to_time).map(&:getutc).join(',')
+        end
+      end
+    end
+  end
+end