flickr-objects 0.1.0 → 0.2.0

data/README.md

@@ -59,8 +59,12 @@ set.id           #=> "11243423"
 set.photos_count #=> 40
 ```
 
-You can always manually instantiate objects with `Flickr.objects.find(id)`
-(in the above example we called `Flickr.people.find(id)`).
+We can learn few things here:
+
+- Interface to object's class methods is always the plural of object's name
+  (above we called `Flickr::Photo.search` with `Flickr.photos.search`).
+- You can always manually instantiate objects with `Flickr.<objects>.find(id)`
+  (in the above example we did `Flickr.people.find(id)`).
 
 Parameters to API methods are not always passed as a hash. For example, instead
 of calling "flickr.people.findByEmail" like this:
@@ -75,12 +79,12 @@ this gem has the convention of calling it like this:
 Flickr.people.find_by_email("janko.marohnic@gmail.com")
 ```
 
-Obvious parameters will always be passed like this. You can still pass a hash of
-other parameters as the last argument.
+This is always the case with obvious (and required) parameters. You can still
+always pass a hash of other parameters as the last argument.
 
-For documentation on valid arguments, just look at the source code under
-[`lib/flickr/api`](https://github.com/janko-m/flickr-objects/blob/master/lib/flickr/api).
-There you will find listed all the API methods of a specific object.
+For documentation on valid arguments, just look at the source code at
+[`lib/flickr/api`](https://github.com/janko-m/flickr-objects/tree/master/lib/flickr/api),
+under a specific object.
 
 ## Sizes
 
@@ -163,7 +167,7 @@ own documentation, so don't be discouraged if you haven't had experience in look
 people's code yet :)
 
 For example, list of `Flickr::Photo`'s attributes can be found in
-[`lib/flickr/objects/media.rb`](https://github.com/janko-m/flickr-objects/blob/master/lib/flickr/objects/media.rb).
+[`lib/flickr/objects/photo.rb`](https://github.com/janko-m/flickr-objects/blob/master/lib/flickr/objects/photo.rb).
 Take a look just to see how it looks like :)
 
 ## Few words

data/lib/flickr/api/api_methods/person.rb

@@ -1,10 +1,12 @@
 class Flickr
   class Person < Object
-    class_api_method :find_by_email,    "flickr.people.findByEmail"
-    class_api_method :find_by_username, "flickr.people.findByUsername"
+    class_api_method :find_by_email,     "flickr.people.findByEmail"
+    class_api_method :find_by_username,  "flickr.people.findByUsername"
+    class_api_method :get_upload_status, "flickr.people.getUploadStatus"
 
     instance_api_method :get_info!,                       "flickr.people.getInfo"
     instance_api_method :get_photos,                      "flickr.people.getPhotos"
+    instance_api_method :get_photos_of,                   "flickr.people.getPhotosOf"
     instance_api_method :get_public_photos,               "flickr.people.getPublicPhotos"
     instance_api_method :get_public_photos_from_contacts, "flickr.photos.getContactsPublicPhotos"
     instance_api_method :get_sets,                        "flickr.photosets.getList"

data/lib/flickr/api/api_methods/photo.rb

@@ -1,15 +1,26 @@
 class Flickr
   class Photo < Object
-    class_api_method :get_from_contacts, "flickr.photos.getContactsPhotos"
-    class_api_method :search,            "flickr.photos.search"
-    class_api_method :delete,            "flickr.photos.delete"
+    class_api_method :get_from_contacts,    "flickr.photos.getContactsPhotos"
+    class_api_method :search,               "flickr.photos.search"
+    class_api_method :delete,               "flickr.photos.delete"
+    class_api_method :get_not_in_set,       "flickr.photos.getNotInSet"
+    class_api_method :get_recent,           "flickr.photos.getRecent"
+    class_api_method :get_untagged,         "flickr.photos.getUntagged"
+    class_api_method :get_with_geo_data,    "flickr.photos.getWithGeoData"
+    class_api_method :get_without_geo_data, "flickr.photos.getWithoutGeoData"
+    class_api_method :get_recently_updated, "flickr.photos.RecentlyUpdated"
 
     instance_api_method :add_tags,         "flickr.photos.addTags"
     instance_api_method :delete,           "flickr.photos.delete"
     instance_api_method :get_info!,        "flickr.photos.getInfo"
     instance_api_method :get_sizes!,       "flickr.photos.getSizes"
+    instance_api_method :get_favorites,    "flickr.photos.getFavorites"
     instance_api_method :remove_tag,       "flickr.photos.removeTag"
     instance_api_method :set_content_type, "flickr.photos.setContentType", aliases: [:content_type=]
     instance_api_method :set_tags,         "flickr.photos.setTags",        aliases: [:tags=]
+    instance_api_method :set_dates,        "flickr.photos.setDates"
+    instance_api_method :set_meta,         "flickr.photos.setMeta"
+    instance_api_method :set_permissions,  "flickr.photos.setPerms"
+    instance_api_method :set_safety_level, "flickr.photos.setSafetyLevel"
   end
 end

data/lib/flickr/api/api_methods/set.rb

@@ -2,13 +2,17 @@ class Flickr
   class Set < Object
     class_api_method :create, "flickr.photosets.create"
     class_api_method :delete, "flickr.photosets.delete"
+    class_api_method :order,  "flickr.photosets.orderSets"
 
-    instance_api_method :add_photo,     "flickr.photosets.addPhoto"
-    instance_api_method :delete,        "flickr.photosets.delete"
-    instance_api_method :edit_photos,   "flickr.photosets.editPhotos"
-    instance_api_method :get_info!,     "flickr.photosets.getInfo"
-    instance_api_method :get_photos,    "flickr.photosets.getPhotos"
-    instance_api_method :remove_photos, "flickr.photosets.removePhotos"
-    instance_api_method :remove_photo,  "flickr.photosets.removePhoto"
+    instance_api_method :add_photo,         "flickr.photosets.addPhoto"
+    instance_api_method :delete,            "flickr.photosets.delete"
+    instance_api_method :edit_photos,       "flickr.photosets.editPhotos"
+    instance_api_method :get_info!,         "flickr.photosets.getInfo"
+    instance_api_method :get_photos,        "flickr.photosets.getPhotos"
+    instance_api_method :remove_photos,     "flickr.photosets.removePhotos"
+    instance_api_method :remove_photo,      "flickr.photosets.removePhoto"
+    instance_api_method :edit_meta,         "flickr.photosets.editMeta"
+    instance_api_method :reorder_photos,    "flickr.photosets.reorderPhotos"
+    instance_api_method :set_primary_photo, "flickr.photosets.setPrimaryPhoto", aliases: [:primary_photo=]
   end
 end

data/lib/flickr/api/person.rb

@@ -12,6 +12,11 @@ class Flickr
       new(response["user"], client)
     end
 
+    def self.get_upload_status(params = {})
+      response = client.get f(__method__), params
+      UploadStatus.new(response["user"], client)
+    end
+
     def get_info!(params = {})
       response = client.get f(__method__), params.merge(user_id: id)
       @hash.update(response["person"])
@@ -23,6 +28,11 @@ class Flickr
       Photo.new_list(response["photos"].delete("photo"), client, response["photos"])
     end
 
+    def get_photos_of(params = {})
+      response = client.get f(__method__), handle_extras(params.merge(user_id: id))
+      Photo.new_list(response["photos"].delete("photo"), client, response["photos"])
+    end
+
     def get_public_photos(params = {})
       response = client.get f(__method__), handle_extras(params.merge(user_id: id))
       Photo.new_list(response["photos"].delete("photo"), client, response["photos"])

data/lib/flickr/api/photo.rb

@@ -16,6 +16,36 @@ class Flickr
       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"])
@@ -28,6 +58,11 @@ class Flickr
       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
@@ -54,5 +89,25 @@ class Flickr
       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

@@ -11,6 +11,11 @@ class Flickr
       find(id).delete(params)
     end
 
+    def self.order(set_ids, params = {})
+      client.post f(__method__), params.merge(photoset_ids: set_ids)
+      set_ids
+    end
+
     def delete(params = {})
       client.post f(__method__), params.merge(photoset_id: id)
       self
@@ -34,14 +39,33 @@ class Flickr
 
     def add_photo(photo_id, params = {})
       client.post f(__method__), params.merge(photoset_id: id, photo_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
 
     def remove_photo(photo_id, params = {})
       client.post f(__method__), params.merge(photoset_id: id, photo_id: photo_id)
+      photo_id
+    end
+
+    def edit_meta(params = {})
+      client.post f(__method__), params.merge(photoset_id: id)
+      params
+    end
+
+    def reorder_photos(photo_ids, params = {})
+      client.post f(__method__), params.merge(photoset_id: id, photo_ids: photo_ids)
+      photo_ids
+    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/object.rb

@@ -28,8 +28,7 @@ class Flickr
         attribute_values[name] = send(name) unless send(name).nil?
       end
       class_name = self.class.name
-      id = "0x%x" % (object_id << 1)
-      "#<#{class_name}:#{id} #{attribute_values.map { |k, v| "#{k}=#{v.inspect}" }.join(" ")}>"
+      "#<#{class_name}: #{attribute_values.map { |k, v| "#{k}=#{v.inspect}" }.join(" ")}>"
     end
 
     def ==(other)

data/lib/flickr/objects.rb

@@ -7,18 +7,19 @@ class Flickr
   class Set    < Object; end
 
   # Meta objects
-  class Visibility   < Object; end
-  class Permissions  < Object; end
-  class Note         < Object; end
-  class Tag          < Object; end
-  class Location     < Object; end
-  class UploadTicket < Object; end
+  class Visibility           < Object; end
+  class Permissions          < Object; end
+  class Note                 < Object; end
+  class Tag                  < Object; end
+  class Location             < Object; end
+  class UploadTicket         < Object; end
+  class Person::UploadStatus < Object; end
 
   autoload :List, "flickr/objects/list"
 end
 
 objects = Flickr::Object.children.dup
 objects.each do |object|
-  underscored_name = object.name.split("::").last.split(/(?<=\w)(?=[A-Z])/).map(&:downcase).join("_")
-  require "flickr/objects/#{underscored_name}"
+  underscored_name = object.name.split("::")[1..-1].map { |s| s.split(/(?<=\w)(?=[A-Z])/).map(&:downcase).join("_") }
+  require "flickr/objects/#{underscored_name.join("/")}"
 end

data/lib/flickr/objects/attribute_values/person.rb

@@ -16,6 +16,7 @@ class Flickr
       mobile_url:           [->{ @hash["mobileurl"]["_content"] }],
       first_photo_taken:    [->{ @hash["photos"]["firstdatetaken"]["_content"] }],
       first_photo_uploaded: [->{ @hash["photos"]["firstdate"]["_content"] }],
+      favorited_at:         [->{ @hash["favedate"] }],
       photos_count:         [->{ @hash["photos"]["count"]["_content"] }],
       photo_views_count:    [->{ @hash["photos"]["views"]["_content"] }],
     }

data/lib/flickr/objects/attribute_values/person/upload_status.rb

@@ -0,0 +1,16 @@
+class Flickr
+  class Person::UploadStatus < Object
+    class Month < Object
+      self.attribute_values = {
+        maximum:   [->{ @hash["maxkb"] / 1024 }],
+        used:      [->{ @hash["usedkb"] / 1024 }],
+        remaining: [->{ @hash["remainingkb"] / 1024 }],
+      }
+    end
+
+    self.attribute_values = {
+      current_month:      [->{ @hash["bandwidth"].slice("maxkb", "usedkb", "remainingkb") }],
+      maximum_photo_size: [->{ @hash["filesize"]["maxmb"] }],
+    }
+  end
+end

data/lib/flickr/objects/attribute_values/photo.rb

@@ -29,7 +29,7 @@ class Flickr
                                 if @hash["owner"].is_a?(String)
                                   {
                                     "id"         => @hash["owner"],
-                                    "username"   => @hash["ownername"],
+                                    "username"   => @hash["ownername"] || @hash["username"],
                                     "iconserver" => @hash["iconserver"],
                                     "iconfarm"   => @hash["iconfarm"],
                                   }

data/lib/flickr/objects/person.rb

@@ -22,6 +22,7 @@ class Flickr
 
     attribute :first_photo_taken,    Time
     attribute :first_photo_uploaded, Time
+    attribute :favorited_at,         Time
 
     attribute :photos_count,         Integer
     attribute :photo_views_count,    Integer

data/lib/flickr/objects/person/upload_status.rb

@@ -0,0 +1,14 @@
+require_relative "../attribute_values/person/upload_status"
+
+class Flickr
+  class Person::UploadStatus < Object
+    class Month < Object
+      attribute :maximum,   Integer
+      attribute :used,      Integer
+      attribute :remaining, Integer
+    end
+
+    attribute :current_month,      Month
+    attribute :maximum_photo_size, Integer
+  end
+end

data/lib/flickr/version.rb

@@ -1,3 +1,3 @@
 class Flickr
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickr-objects
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-24 00:00:00.000000000 Z
+date: 2013-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -226,6 +226,7 @@ files:
 - lib/flickr/objects/attribute_values/location.rb
 - lib/flickr/objects/attribute_values/note.rb
 - lib/flickr/objects/attribute_values/permissions.rb
+- lib/flickr/objects/attribute_values/person/upload_status.rb
 - lib/flickr/objects/attribute_values/person.rb
 - lib/flickr/objects/attribute_values/photo.rb
 - lib/flickr/objects/attribute_values/set.rb
@@ -236,6 +237,7 @@ files:
 - lib/flickr/objects/location.rb
 - lib/flickr/objects/note.rb
 - lib/flickr/objects/permissions.rb
+- lib/flickr/objects/person/upload_status.rb
 - lib/flickr/objects/person.rb
 - lib/flickr/objects/photo.rb
 - lib/flickr/objects/set.rb
@@ -267,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -330563932466293642
+      hash: -3989441013380527644
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23