flickr-objects 0.2.0 → 0.3.0

data/lib/flickr/api/photo.rb

@@ -1,113 +1,218 @@
-require_relative "api_methods/photo"
+module Flickr
+  module Api
+
+    class Photo < Abstract
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photos.search](http://www.flickr.com/services/api/flickr.photos.search.html)
+      #
+      def search(params = {})
+        response = get "photos.search", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photos.getContactsPhotos](http://www.flickr.com/services/api/flickr.photos.getContactsPhotos.html)
+      #
+      def get_from_contacts(params = {})
+        response = get "photos.getContactsPhotos", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photos.getNotInSet](http://www.flickr.com/services/api/flickr.photos.getNotInSet.html)
+      #
+      def get_not_in_set(params = {})
+        response = get "photos.getNotInSet", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photos.getRecent](http://www.flickr.com/services/api/flickr.photos.getRecent.html)
+      #
+      def get_recent(params = {})
+        response = get "photos.getRecent", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photos.getUntagged](http://www.flickr.com/services/api/flickr.photos.getUntagged.html)
+      #
+      def get_untagged(params = {})
+        response = get "photos.getUntagged", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photos.getWithGeoData](http://www.flickr.com/services/api/flickr.photos.getWithGeoData.html)
+      #
+      def get_with_geo_data(params = {})
+        response = get "photos.getWithGeoData", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photos.getWithoutGeoData](http://www.flickr.com/services/api/flickr.photos.getWithoutGeoData.html)
+      #
+      def get_without_geo_data(params = {})
+        response = get "photos.getWithoutGeoData", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photos.RecentlyUpdated](http://www.flickr.com/services/api/flickr.photos.RecentlyUpdated.html)
+      #
+      def get_recently_updated(params = {})
+        response = get "photos.recentlyUpdated", params
+        new_list(:Photo, response["photos"].delete("photo"), response["photos"])
+      end
+
+      ##
+      # @param photo_id [String]
+      # @return [Flickr::Object::Photo]
+      # @docs [flickr.photos.getInfo](http://www.flickr.com/services/api/flickr.photos.getInfo.html)
+      #
+      def get_info(photo_id, params = {})
+        response = get "photos.getInfo", params.merge(photo_id: photo_id)
+        new_object(:Photo, response["photo"])
+      end
+
+      ##
+      # @param photo_id [String]
+      # @return [Flickr::Object::Photo]
+      # @docs [flickr.photos.getSizes](http://www.flickr.com/services/api/flickr.photos.getInfo.html)
+      #
+      def get_sizes(photo_id, params = {})
+        response = get "photos.getSizes", params.merge(photo_id: photo_id)
+        new_object(:Photo, response)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @return [Flickr::Object::Photo]
+      # @docs [flickr.photos.getExif](http://www.flickr.com/services/api/flickr.photos.getInfo.html)
+      #
+      def get_exif(photo_id, params = {})
+        response = get "photos.getExif", params.merge(photo_id: photo_id)
+        new_object(:Photo, response["photo"])
+      end
+
+      ##
+      # @param photo_id [String]
+      # @return [Flickr::Object::List<Flickr::Object::Person>]
+      # @docs [flickr.photos.getFavorites](http://www.flickr.com/services/api/flickr.photos.getFavorites.html)
+      #
+      def get_favorites(photo_id, params = {})
+        response = get "photos.getFavorites", params.merge(photo_id: photo_id)
+        new_list(:Person, response["photo"].delete("person"), response["photo"])
+      end
+
+      ##
+      # @param photo_id [String]
+      # @return [response]
+      # @docs [flickr.photos.delete](http://www.flickr.com/services/api/flickr.photos.delete.html)
+      #
+      def delete(photo_id, params = {})
+        post "photos.delete", params.merge(photo_id: photo_id)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @param content_type [String]
+      # @return [response]
+      # @docs [flickr.photos.setContentType](http://www.flickr.com/services/api/flickr.photos.setContentType.html)
+      #
+      def set_content_type(photo_id, content_type, params = {})
+        post "photos.setContentType", params.merge(photo_id: photo_id, content_type: content_type)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @param tags [String] Space-delimited list of tags (see documentation below)
+      # @return [response]
+      # @docs [flickr.photos.setTags](http://www.flickr.com/services/api/flickr.photos.setTags.html)
+      #
+      def set_tags(photo_id, tags, params = {})
+        post "photos.setTags", params.merge(photo_id: photo_id, tags: tags)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @param tags [String] Space-delimited list of tags (see documentation below)
+      # @return [response]
+      # @docs [flickr.photos.addTags](http://www.flickr.com/services/api/flickr.photos.addTags.html)
+      #
+      def add_tags(photo_id, tags, params = {})
+        post "photos.addTags", params.merge(photo_id: photo_id, tags: tags)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @param tag_id [String]
+      # @return [response]
+      # @docs [flickr.photos.removeTag](http://www.flickr.com/services/api/flickr.photos.removeTag.html)
+      #
+      def remove_tag(photo_id, tag_id, params = {})
+        post "photos.removeTag", params.merge(photo_id: photo_id, tag_id: tag_id)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @param params [Hash] See documentation below
+      # @return [response]
+      # @docs [flickr.photos.setDates](http://www.flickr.com/services/api/flickr.photos.setDates.html)
+      #
+      def set_dates(photo_id, params = {})
+        post "photos.setDates", params.merge(photo_id: photo_id)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @param params [Hash] See documentation below
+      # @return [response]
+      # @docs [flickr.photos.setMeta](http://www.flickr.com/services/api/flickr.photos.setMeta.html)
+      #
+      def set_meta(photo_id, params = {})
+        post "photos.setMeta", params.merge(photo_id: photo_id)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @param params [Hash] See documentation below
+      # @return [response]
+      # @docs [flickr.photos.setPerms](http://www.flickr.com/services/api/flickr.photos.setPerms.html)
+      #
+      def set_permissions(photo_id, params = {})
+        post "photos.setPerms", params.merge(photo_id: photo_id)
+      end
+
+      ##
+      # @param photo_id [String]
+      # @param params [Hash] See documentation below
+      # @return [response]
+      # @docs [flickr.photos.setSafetyLevel](http://www.flickr.com/services/api/flickr.photos.setSafetyLevel.html)
+      #
+      def set_safety_level(photo_id, params = {})
+        post "photos.setSafetyLevel", params.merge(photo_id: photo_id)
+      end
 
-class Flickr
-  class Photo < Object
-    def self.search(params = {})
-      response = client.get f(__method__), handle_extras(params)
-      new_list(response["photos"].delete("photo"), client, response["photos"])
     end
 
-    def self.get_from_contacts(params = {})
-      response = client.get f(__method__), handle_extras(params)
-      new_list(response["photos"].delete("photo"), client, response["photos"])
-    end
-
-    def self.delete(id, params = {})
-      find(id).delete(params)
-    end
-
-    def self.get_not_in_set(params = {})
-      response = client.get f(__method__), handle_extras(params)
-      new_list(response["photos"].delete("photo"), client, response["photos"])
-    end
-
-    def self.get_recent(params = {})
-      response = client.get f(__method__), handle_extras(params)
-      new_list(response["photos"].delete("photo"), client, response["photos"])
-    end
-
-    def self.get_untagged(params = {})
-      response = client.get f(__method__), handle_extras(params)
-      new_list(response["photos"].delete("photo"), client, response["photos"])
-    end
-
-    def self.get_with_geo_data(params = {})
-      response = client.get f(__method__), handle_extras(params)
-      new_list(response["photos"].delete("photo"), client, response["photos"])
-    end
-
-    def self.get_without_geo_data(params = {})
-      response = client.get f(__method__), handle_extras(params)
-      new_list(response["photos"].delete("photo"), client, response["photos"])
-    end
-
-    def self.get_recently_updated(params = {})
-      response = client.get f(__method__), handle_extras(params)
-      new_list(response["photos"].delete("photo"), client, response["photos"])
-    end
-
-    def get_info!(params = {})
-      response = client.get f(__method__), params.merge(photo_id: id)
-      @hash.update(response["photo"])
-      self
-    end
-
-    def get_sizes!(params = {})
-      response = client.get f(__method__), params.merge(photo_id: id)
-      @hash.update(response["sizes"])
-      self
-    end
-
-    def get_favorites(params = {})
-      response = client.get f(__method__), params.merge(photo_id: id)
-      Person.new_list(response["photo"].delete("person"), client, response["photo"])
-    end
-
-    def delete(params = {})
-      client.post f(__method__), params.merge(photo_id: id)
-      self
-    end
-
-    def set_content_type(content_type, params = {})
-      client.post f(__method__), params.merge(photo_id: id, content_type: content_type)
-      content_type
-    end
-    alias content_type= set_content_type
-
-    def set_tags(tags, params = {})
-      client.post f(__method__), params.merge(photo_id: id, tags: tags)
-      tags
-    end
-    alias tags= set_tags
-
-    def add_tags(tags, params = {})
-      client.post f(__method__), params.merge(photo_id: id, tags: tags)
-      tags
-    end
-
-    def remove_tag(tag_id, params = {})
-      client.post f(__method__), params.merge(photo_id: id, tag_id: tag_id)
-      tag_id
-    end
-
-    def set_dates(params = {})
-      client.post f(__method__), params.merge(photo_id: id)
-      params
-    end
-
-    def set_meta(params = {})
-      client.post f(__method__), params.merge(photo_id: id)
-      params
-    end
-
-    def set_permissions(params = {})
-      client.post f(__method__), params.merge(photo_id: id)
-      params
-    end
-
-    def set_safety_level(params = {})
-      client.post f(__method__), params.merge(photo_id: id)
-      params
-    end
   end
 end

data/lib/flickr/api/set.rb

@@ -1,71 +1,130 @@
-require_relative "api_methods/set"
+module Flickr
+  module Api
 
-class Flickr
-  class Set < Object
-    def self.create(params = {})
-      response = client.post f(__method__), params
-      new(response["photoset"], client)
-    end
+    class Set < Abstract
 
-    def self.delete(id, params = {})
-      find(id).delete(params)
-    end
+      ##
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::Set]
+      # @docs [flickr.photosets.create](http://www.flickr.com/services/api/flickr.photosets.create.html)
+      #
+      def create(params = {})
+        response = post "photosets.create", params
+        new_object(:Set, response["photoset"])
+      end
 
-    def self.order(set_ids, params = {})
-      client.post f(__method__), params.merge(photoset_ids: set_ids)
-      set_ids
-    end
+      ##
+      # @param set_ids [String] Comma-delimited list of set IDs (see documentation below)
+      # @return [response]
+      # @docs [flickr.photosets.orderSets](http://www.flickr.com/services/api/flickr.photosets.orderSets.html)
+      #
+      def order(set_ids, params = {})
+        post "photosets.orderSets", params.merge(photoset_ids: set_ids)
+      end
 
-    def delete(params = {})
-      client.post f(__method__), params.merge(photoset_id: id)
-      self
-    end
+      ##
+      # @param set_id [String]
+      # @return [response]
+      # @docs [flickr.photosets.delete](http://www.flickr.com/services/api/flickr.photosets.delete.html)
+      #
+      def delete(set_id, params = {})
+        post "photosets.delete", params.merge(photoset_id: set_id)
+      end
 
-    def edit_photos(params = {})
-      client.post f(__method__), params.merge(photoset_id: id)
-      self
-    end
+      ##
+      # @param set_id [String]
+      # @param params [Hash] See documentation below
+      # @return [response]
+      # @docs [flickr.photosets.editPhotos](http://www.flickr.com/services/api/flickr.photosets.editPhotos.html)
+      #
+      def edit_photos(set_id, params = {})
+        post "photosets.editPhotos", params.merge(photoset_id: set_id)
+      end
 
-    def get_info!(params = {})
-      response = client.get f(__method__), params.merge(photoset_id: id)
-      @hash.update(response["photoset"])
-      self
-    end
+      ##
+      # @param set_id [String]
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::Set]
+      # @docs [flickr.photosets.getInfo](http://www.flickr.com/services/api/flickr.photosets.getInfo.html)
+      #
+      def get_info(set_id, params = {})
+        response = get "photosets.getInfo", params.merge(photoset_id: set_id)
+        new_object(:Set, response["photoset"])
+      end
 
-    def get_photos(params = {})
-      response = client.get f(__method__), handle_extras(params.merge(photoset_id: id))
-      Photo.new_list(response["photoset"].delete("photo"), client, response["photoset"])
-    end
+      ##
+      # @param set_id [String]
+      # @param params [Hash] See documentation below
+      # @return [Flickr::Object::List<Flickr::Object::Photo>]
+      # @docs [flickr.photosets.getPhotos](http://www.flickr.com/services/api/flickr.photosets.getPhotos.html)
+      #
+      def get_photos(set_id, params = {})
+        response = get "photosets.getPhotos", params.merge(photoset_id: set_id)
+        new_list(:Photo, response["photoset"].delete("photo").map { |h| h.merge("owner" => response["photoset"]["owner"]) }, response["photoset"])
+      end
 
-    def add_photo(photo_id, params = {})
-      client.post f(__method__), params.merge(photoset_id: id, photo_id: photo_id)
-      photo_id
-    end
+      ##
+      # @param set_id [String]
+      # @param photo_id [String]
+      # @param params [Hash] See documentation below
+      # @return [response]
+      # @docs [flickr.photosets.addPhoto](http://www.flickr.com/services/api/flickr.photosets.addPhoto.html)
+      #
+      def add_photo(set_id, photo_id, params = {})
+        post "photosets.addPhoto", params.merge(photoset_id: set_id, photo_id: photo_id)
+      end
 
-    def remove_photos(photo_ids, params = {})
-      client.post f(__method__), params.merge(photoset_id: id, photo_ids: photo_ids)
-      photo_ids
-    end
+      ##
+      # @param set_id [String]
+      # @param photo_ids [String] Comma-delimited list of photo IDs (see documentation below)
+      # @return [response]
+      # @docs [flickr.photosets.removePhotos](http://www.flickr.com/services/api/flickr.photosets.removePhotos.html)
+      #
+      def remove_photos(set_id, photo_ids, params = {})
+        post "photosets.removePhotos", params.merge(photoset_id: set_id, photo_ids: photo_ids)
+      end
 
-    def remove_photo(photo_id, params = {})
-      client.post f(__method__), params.merge(photoset_id: id, photo_id: photo_id)
-      photo_id
-    end
+      ##
+      # @param set_id [String]
+      # @param photo_id [String]
+      # @return [response]
+      # @docs [flickr.photosets.removePhoto](http://www.flickr.com/services/api/flickr.photosets.removePhoto.html)
+      #
+      def remove_photo(set_id, photo_id, params = {})
+        post "photosets.removePhoto", params.merge(photoset_id: set_id, photo_id: photo_id)
+      end
 
-    def edit_meta(params = {})
-      client.post f(__method__), params.merge(photoset_id: id)
-      params
-    end
+      ##
+      # @param set_id [String]
+      # @param params [Hash] See documentation below
+      # @return [response]
+      # @docs [flickr.photosets.editMeta](http://www.flickr.com/services/api/flickr.photosets.editMeta.html)
+      #
+      def edit_meta(set_id, params = {})
+        post "photosets.editMeta", params.merge(photoset_id: set_id)
+      end
 
-    def reorder_photos(photo_ids, params = {})
-      client.post f(__method__), params.merge(photoset_id: id, photo_ids: photo_ids)
-      photo_ids
-    end
+      ##
+      # @param set_id [String]
+      # @param photo_ids [String] Comma-delimited list of photo IDs (see documentation below)
+      # @return [response]
+      # @docs [flickr.photosets.reorderPhotos](http://www.flickr.com/services/api/flickr.photosets.reorderPhotos.html)
+      #
+      def reorder_photos(set_id, photo_ids, params = {})
+        post "photosets.reorderPhotos", params.merge(photoset_id: set_id, photo_ids: photo_ids)
+      end
+
+      ##
+      # @param set_id [String]
+      # @param photo_id [String]
+      # @return [response]
+      # @docs [flickr.photosets.setPrimaryPhoto](http://www.flickr.com/services/api/flickr.photosets.setPrimaryPhoto.html)
+      #
+      def set_primary_photo(set_id, photo_id, params = {})
+        post "photosets.setPrimaryPhoto", params.merge(photoset_id: set_id, photo_id: photo_id)
+      end
 
-    def set_primary_photo(photo, params = {})
-      client.post f(__method__), params.merge(photoset_id: id, photo_id: (photo.is_a?(Photo) ? photo.id : photo))
-      photo
     end
-    alias primary_photo= set_primary_photo
+
   end
 end

data/lib/flickr/api/upload_ticket.rb

@@ -1,10 +1,21 @@
-require_relative "api_methods/upload_ticket"
+module Flickr
+  module Api
+
+    class UploadTicket < Abstract
+
+      ##
+      # Used to check the status of a photo uploaded or replaced asynchronously.
+      #
+      # @param ticket_ids [String] Comma-delimited list of ticket IDs (see documentation below)
+      # @return [Flickr::Object::List<Flickr::Object::UploadTicket>]
+      # @docs [flickr.photos.upload.checkTickets](http://www.flickr.com/services/api/flickr.photos.upload.checkTickets.html)
+      #
+      def check(ticket_ids, params = {})
+        response = get "photos.upload.checkTickets", params.merge(tickets: ticket_ids)
+        new_list(:UploadTicket, response["uploader"].delete("ticket"), response["uploader"])
+      end
 
-class Flickr
-  class UploadTicket < Object
-    def self.check(tickets, params = {})
-      response = client.get f(__method__), params.merge(tickets: tickets)
-      new_list(response["uploader"].delete("ticket"), client, response["uploader"])
     end
+
   end
 end

data/lib/flickr/api.rb

@@ -1,49 +1,104 @@
-require "flickr/client"
-require "flickr/api_caller"
+module Flickr
 
-class Flickr
-  include ApiCaller
+  module Api
 
-  def initialize(*access_token)
-    @access_token = access_token
-  end
+    extend Flickr::AutoloadHelper
 
-  def client
-    @client ||= MethodsClient.new(@access_token)
-  end
+    autoload_names \
+      :Abstract, :General, :Photo, :Person, :Set, :UploadTicket
 
-  def upload_client
-    @upload_client ||= UploadClient.new(@access_token)
-  end
+    ##
+    # @return [Flickr::Api::Photo]
+    #
+    def photos
+      Flickr::Api::Photo.new(access_token)
+    end
 
-  def self.client
-    @client ||= MethodsClient.new(configuration.access_token)
-  end
+    ##
+    # @return [Flickr::Api::Person]
+    #
+    def people
+      Flickr::Api::Person.new(access_token)
+    end
 
-  def self.upload_client
-    @upload_client ||= UploadClient.new(configuration.access_token)
-  end
-end
+    ##
+    # @return [Flickr::Api::Set]
+    #
+    def sets
+      Flickr::Api::Set.new(access_token)
+    end
+
+    ##
+    # @return [Flickr::Api::UploadTicket]
+    #
+    def upload_tickets
+      Flickr::Api::UploadTicket.new(access_token)
+    end
+
+    ##
+    # @return [String]
+    # @see Flickr::Api::General#upload
+    #
+    def upload(photo, params = {})
+      api.upload(photo, params)
+    end
+
+    ##
+    # @return [String]
+    # @see Flickr::Api::General#replace
+    #
+    def replace(photo, photo_id, params = {})
+      api.replace(photo, photo_id, params)
+    end
+
+    ##
+    # @return [Flickr::Object::List<Flickr::Object::UploadTicket>]
+    # @deprecated Use `Flickr.upload_tickets.check` instead.
+    # @see Flickr::Api::UploadTicket#check
+    #
+    def check_upload_tickets(tickets, params = {})
+      Flickr.deprecation_warn "`Flickr.check_upload_tickets` is deprecated. Use `Flickr.upload_tickets.check` instead."
+      upload_tickets.check(tickets, params)
+    end
+
+    ##
+    # @return [Array<String>]
+    # @see Flickr::Api::General#get_methods
+    #
+    def get_methods(params = {})
+      api.get_methods(params)
+    end
+
+    ##
+    # @return [Hash]
+    # @see Flickr::Api::General#test_login
+    #
+    def test_login(params = {})
+      api.test_login(params)
+    end
 
-require "flickr/api/flickr"
+    ##
+    # @return [Hash]
+    # @see Flickr::Api::General#test_echo
+    #
+    def test_echo(params = {})
+      api.test_echo(params)
+    end
 
-class Flickr
-  def self.map_interface(method, klass)
-    define_method(method) do
-      klass.tap do |klass|
-        klass.instance_variable_set("@client", client)
-      end
+    ##
+    # @return [Hash]
+    # @see Flickr::Api::General#test_null
+    #
+    def test_null(params = {})
+      api.test_null(params)
     end
 
-    define_singleton_method(method) do
-      klass.tap do |klass|
-        klass.instance_variable_set("@client", client)
-      end
+    private
+
+    def api
+      Flickr::Api::General.new(access_token)
     end
+
   end
 
-  map_interface :photos,         Photo
-  map_interface :people,         Person
-  map_interface :sets,           Set
-  map_interface :upload_tickets, UploadTicket
 end