flickrie 1.0.0 → 1.0.1

data/lib/flickrie/media/note.rb

@@ -9,6 +9,7 @@ module Flickrie
       end
 
       def [](key) @info[key] end
+      # @!parse attr_reader :hash
       def hash() @info end
 
       private

data/lib/flickrie/media/tag.rb

@@ -1,19 +1,25 @@
 module Flickrie
   module Media
     class Tag
+      # @!parse attr_reader :id
       def id()      @info['id']       end
+      # @!parse attr_reader :raw
       def raw()     @info['raw']      end
+      # @!parse attr_reader :content
       def content() @info['_content'] end
 
+      # @!parse attr_reader :machine_tag?
       def machine_tag?
         @info['machine_tag'].to_i == 1 if @info['machine_tag']
       end
 
+      # @!parse attr_reader :author
       def author
         User.new('nsid' => @info['author']) if @info['author']
       end
 
       def [](key) @info[key] end
+      # @!parse attr_reader :hash
       def hash() @info end
 
       private

data/lib/flickrie/media/visibility.rb

@@ -1,12 +1,17 @@
 module Flickrie
   module Media
     class Visibility
+      # @!parse attr_reader :public?
       def public?()   @info['ispublic'].to_i == 1 if @info['ispublic']   end
+      # @!parse attr_reader :friends?
       def friends?()  @info['isfriend'].to_i == 1 if @info['isfriend']   end
+      # @!parse attr_reader :family?
       def family?()   @info['isfamily'].to_i == 1 if @info['isfamily']   end
+      # @!parse attr_reader :contacts?
       def contacts?() @info['iscontact'].to_i == 1 if @info['iscontact'] end
 
       def [](key) @info[key] end
+      # @!parse attr_reader :hash
       def hash() @info end
 
       private

data/lib/flickrie/media_count.rb

@@ -2,8 +2,12 @@ require 'date'
 
 module Flickrie
   class MediaCount
+    # @!parse attr_reader :value
     def value() Integer(@info['count']) rescue nil end
 
+    # @return [Range]
+    #
+    # @!parse attr_reader :date_range
     def date_range
       dates =
         case @dates_kind
@@ -19,10 +23,13 @@ module Flickrie
     end
     alias time_interval date_range
 
+    # @!parse attr_reader :from
     def from() date_range.begin end
+    # @!parse attr_reader :to
     def to()   date_range.end   end
 
     def [](key) @info[key] end
+    # @!parse attr_reader :hash
     def hash() @info end
 
     private

data/lib/flickrie/oauth.rb

@@ -7,7 +7,7 @@ module Flickrie
 
     private
 
-      def self.new_connection(request_token = nil) # :nodoc:
+      def self.new_connection(request_token = nil)
         Faraday.new(params) do |b|
           b.use Middleware::Retry
           b.use FaradayMiddleware::OAuth,
@@ -27,8 +27,8 @@ module Flickrie
         {
           :url => URL,
           :request => {
-            :open_timeout => Flickrie.open_timeout || OPEN_TIMEOUT,
-            :timeout => Flickrie.timeout || TIMEOUT
+            :open_timeout => Flickrie.open_timeout || DEFAULTS[:open_timeout],
+            :timeout => Flickrie.timeout || DEFAULTS[:timeout]
           }
         }
       end

data/lib/flickrie/photo.rb

@@ -1,5 +1,4 @@
 module Flickrie
-  # See Flickrie::Media for the other methods.
   class Photo
     include Media
 
@@ -16,6 +15,7 @@ module Flickrie
       'Original'   => 'o'
     }
 
+    # @!parse attr_reader :size
     def size() @size end
 
     def square!(number) @size = "Square #{number}"; self end
@@ -32,8 +32,7 @@ module Flickrie
     def large(number)  dup.large!(number)  end
     def original()     dup.original!       end
 
-    #--
-    # Alternate size methods
+    # @comment Alternate size methods
     def square75()   square(75)   end
     def square75!()  square!(75)  end
     def square150()  square(150)  end
@@ -58,13 +57,17 @@ module Flickrie
       SIZES.select { |_,v| @info["url_#{v}"] }.keys
     end
 
+    # @!parse attr_reader :width
     def width()  Integer(@info["width_#{size_abbr}"])  rescue nil end
+    # @!parse attr_reader :height
     def height() Integer(@info["height_#{size_abbr}"]) rescue nil end
+    # @!parse attr_reader :source_url
     def source_url() @info["url_#{size_abbr}"] end
 
+    # @!parse attr_reader :rotation
     def rotation() Integer(@info['rotation']) rescue nil end
 
-    # Same as calling <tt>Flickrie.get_photo_sizes(photo.id)</tt>
+    # Same as calling `Flickrie.get_photo_sizes(photo.id)`.
     def get_sizes(params = {}, info = nil)
       info ||= Flickrie.client.get_media_sizes(id, params).body['sizes']
       @info['usage'] ||= {}

data/lib/flickrie/set.rb

@@ -1,52 +1,72 @@
 module Flickrie
   class Set
+    # @!parse attr_reader :id
     def id()          @info['id']          end
+    # @!parse attr_reader :secret
     def secret()      @info['secret']      end
+    # @!parse attr_reader :server
     def server()      @info['server']      end
+    # @!parse attr_reader :farm
     def farm()        @info['farm']        end
+    # @!parse attr_reader :title
     def title()       @info['title']       end
+    # @!parse attr_reader :description
     def description() @info['description'] end
 
+    # @!parse attr_reader :primary_media_id
     def primary_media_id() @info['primary'] end
     alias primary_photo_id primary_media_id
     alias primary_video_id primary_media_id
 
+    # @!parse attr_reader :views_count
     def views_count()    Integer(@info['count_views'])    rescue nil end
+    # @!parse attr_reader :comments_count
     def comments_count() Integer(@info['count_comments']) rescue nil end
+    # @!parse attr_reader :photos_count
     def photos_count()   Integer(@info['count_photos'])   rescue nil end
+    # @!parse attr_reader :videos_count
     def videos_count()   Integer(@info['count_videos'])   rescue nil end
+    # @!parse attr_reader :media_count
     def media_count
       photos_count + videos_count rescue nil
     end
 
-    # Returns an instance of Flickrie::User
+    # @return [Flickrie::User]
+    #
+    # @!parse attr_reader :owner
     def owner() User.new('nsid' => @info['owner']) if @info['owner'] end
 
-    # Same as calling <tt>Flickrie.photos_from_set(set.id)</tt>
+    # Same as calling `Flickrie.photos_from_set(set.id)`.
     def photos(params = {}) Flickrie.photos_from_set(id, params) end
-    # Same as calling <tt>Flickrie.videos_from_set(set.id)</tt>
+    # Same as calling `Flickrie.videos_from_set(set.id)`.
     def videos(params = {}) Flickrie.videos_from_set(id, params) end
-    # Same as calling <tt>Flickrie.media_from_set(set.id)</tt>
+    # Same as calling `Flickrie.media_from_set(set.id)`.
     def media(params = {})  Flickrie.media_from_set(id, params)  end
 
+    # @!parse attr_reader :can_comment?
     def can_comment?() Integer(@info['can_comment']) == 1 rescue nil end
 
-    #--
-    # TODO: Figure out what this is
+    # @comment TODO: Figure out what this is
+    # @!parse attr_reader :needs_interstitial?
     def needs_interstitial?() Integer(@info['needs_interstitial']) == 1 rescue nil end
+    # @!parse attr_reader :visibility_can_see_set?
     def visibility_can_see_set?() Integer(@info['visibility_can_see_set']) == 1 rescue nil end
 
+    # @!parse attr_reader :created_at
     def created_at() Time.at(Integer(@info['date_create'])) rescue nil end
+    # @!parse attr_reader :updated_at
     def updated_at() Time.at(Integer(@info['date_update'])) rescue nil end
 
+    # @!parse attr_reader :url
     def url
       "http://www.flickr.com/photos/#{owner.nsid}/sets/#{id}"
     end
 
     def [](key) @info[key] end
+    # @!parse attr_reader :hash
     def hash() @info end
 
-    # Same as calling <tt>Flickrie.get_set_info(set.id)</tt>
+    # Same as calling `Flickrie.get_set_info(set.id)`
     def get_info(info = nil)
       info ||= Flickrie.client.get_set_info(id).body['photoset']
       @info.update(info)

data/lib/flickrie/ticket.rb

@@ -1,15 +1,20 @@
 module Flickrie
   class Ticket
+    # @!parse attr_reader :id
     def id()       @info['id']      end
+    # @!parse attr_reader :media_id
     def media_id() @info['photoid'] end
     alias photo_id media_id
     alias video_id media_id
 
+    # @!parse attr_reader :complete?
     def complete?() Integer(@info['complete']) == 1 rescue nil end
 
+    # @!parse attr_reader :imported_at
     def imported_at() Time.at(Integer(@info['imported'])) rescue nil end
 
     def [](key) @info[key] end
+    # @!parse attr_reader :hash
     def hash() @info end
 
     private

data/lib/flickrie/upload_client.rb

@@ -1,43 +1,7 @@
-require 'faraday_middleware'
+require 'faraday'
 
 module Flickrie
-  class << self
-    # :nodoc:
-    def upload_client
-      @upload_client ||= new_upload_client
-    end
-
-    def new_upload_client(access_token_hash = {})
-      UploadClient.new(upload_params) do |b|
-        b.use Middleware::Retry
-        b.use FaradayMiddleware::OAuth,
-          :consumer_key => api_key,
-          :consumer_secret => shared_secret,
-          :token => access_token_hash[:token] || access_token,
-          :token_secret => access_token_hash[:secret] || access_secret
-        b.request :multipart
-
-        b.use Middleware::UploadStatusCheck
-        b.use FaradayMiddleware::ParseXml
-        b.use Middleware::OAuthCheck
-
-        b.adapter :net_http
-      end
-    end
-
-    private
-
-    def upload_params
-      {
-        :url => 'http://api.flickr.com/services',
-        :request => {
-          :open_timeout => open_timeout || OPEN_TIMEOUT
-        }
-      }
-    end
-  end
-
-  class UploadClient < Faraday::Connection # :nodoc:
+  class UploadClient < Faraday::Connection
     def upload(media, params = {})
       file = get_file(media, params[:content_type])
       title = file.original_filename.match(/\.\w{3,4}$/).pre_match
@@ -76,7 +40,7 @@ module Flickrie
       %w[.wmv]                                => 'video/x-ms-wmv',
       %w[.flv .f4v .f4p .f4a .f4b]            => 'video/x-flv',
       %w[.avi]                                => 'video/avi'
-    }.freeze
+    }
 
     def get_file(object, content_type = nil)
       file, content_type, file_path =

data/lib/flickrie/user.rb

@@ -2,16 +2,26 @@ require 'date'
 
 module Flickrie
   class User
+    # @!parse attr_reader :id
     def id()           @info['id']          end
+    # @!parse attr_reader :nsid
     def nsid()         @info['nsid']        end
+    # @!parse attr_reader :username
     def username()     @info['username']    end
+    # @!parse attr_reader :real_name
     def real_name()    @info['realname']    end
+    # @!parse attr_reader :location
     def location()     @info['location']    end
+    # @!parse attr_reader :description
     def description()  @info['description'] end
+    # @!parse attr_reader :path_alias
     def path_alias()   @info['path_alias']  end
+    # @!parse attr_reader :icon_server
     def icon_server()  @info['iconserver']  end
+    # @!parse attr_reader :icon_farm
     def icon_farm()    @info['iconfarm']    end
 
+    # @!parse attr_reader :buddy_icon_url
     def buddy_icon_url
       if icon_farm
         if icon_server.to_i > 0 && (nsid || id)
@@ -22,34 +32,46 @@ module Flickrie
       end
     end
 
-    # ==== Example
+    # Returns the time zone of the user. Example:
     #
-    #   user.time_zone.offset # => "+01:00"
-    #   user.time_zone.label  # => "Sarajevo, Skopje, Warsaw, Zagreb"
+    #     user.time_zone.offset # => "+01:00"
+    #     user.time_zone.label  # => "Sarajevo, Skopje, Warsaw, Zagreb"
+    #
+    # @!parse attr_reader :time_zone
     def time_zone() Struct.new(:label, :offset).new(*@info['timezone'].values) rescue nil end
 
+    # @!parse attr_reader :photos_url
     def photos_url()  @info['photosurl']  || "http://www.flickr.com/photos/#{nsid || id}" end
+    # @!parse attr_reader :profile_url
     def profile_url() @info['profileurl'] || "http://www.flickr.com/people/#{nsid || id}" end
+    # @!parse attr_reader :mobile_url
     def mobile_url()  @info['mobileurl'] end
 
+    # @!parse attr_reader :first_taken
     def first_taken() DateTime.parse(@info['photos']['firstdatetaken']).to_time rescue nil end
+    # @!parse attr_reader :first_uploaded
     def first_uploaded() Time.at(Integer(@info['photos']['firstdate'])) rescue nil end
 
+    # @!parse attr_reader :favorited_at
     def favorited_at() Time.at(Integer(@info['favedate'])) rescue nil end
 
+    # @!parse attr_reader :media_count
     def media_count() Integer(@info['photos']['count']) rescue nil end
     alias photos_count media_count
     alias videos_count media_count
 
-    # The same as calling <tt>Flickrie.public_photos_from_user(user.nsid)</tt>
-    def public_photos() Flickrie.public_photos_from_user(nsid || id) end
+    # @comment TODO: public videos, media and without public
+    # The same as calling `Flickrie.public_photos_from_user(user.nsid)`
+    def public_photos(params = {}) Flickrie.public_photos_from_user(nsid || id, params) end
 
+    # @!parse attr_reader :pro?
     def pro?() Integer(@info['ispro']) == 1 rescue nil end
 
     def [](key) @info[key] end
+    # @!parse attr_reader :hash
     def hash() @info end
 
-    # The same as calling <tt>Flickrie.get_user_info(user.nsid)</tt>
+    # The same as calling `Flickrie.get_user_info(user.nsid)`
     def get_info(params = {}, info = nil)
       info ||= Flickrie.client.get_user_info(nsid || id, params).body['person']
       @info.update(info)

data/lib/flickrie/version.rb

@@ -1,3 +1,3 @@
 module Flickrie
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/flickrie/video.rb

@@ -1,22 +1,30 @@
 module Flickrie
-  # See Flickrie::Media for the other methods.
   class Video
     include Media
 
+    # @!parse attr_reader :ready?
     def ready?()   Integer(@video['ready']) == 1   rescue nil end
+    # @!parse attr_reader :failed?
     def failed?()  Integer(@video['failed']) == 1  rescue nil end
+    # @!parse attr_reader :pending?
     def pending?() Integer(@video['pending']) == 1 rescue nil end
 
+    # @!parse attr_reader :duration
     def duration() Integer(@video['duration']) rescue nil end
 
+    # @!parse attr_reader :width
     def width()  Integer(@video['width'])  rescue nil end
+    # @!parse attr_reader :height
     def height() Integer(@video['height']) rescue nil end
 
+    # @!parse attr_reader :source_url
     def source_url()          @video['source_url']          end
+    # @!parse attr_reader :download_url
     def download_url()        @video['download_url']        end
+    # @!parse attr_reader :mobile_download_url
     def mobile_download_url() @video['mobile_download_url'] end
 
-    # This fetches the #source_url, #download_url and the #mobile_download_url
+    # This fetches the {#source\_url}, {#download\_url} and the {#mobile\_download\_url}
     def get_sizes(params = {}, info = nil)
       info ||= Flickrie.client.get_media_sizes(id, params).body['sizes']
       @info['usage'] ||= {}
@@ -35,6 +43,7 @@ module Flickrie
       self
     end
 
+    # Same as calling `Flickrie.get_video_info(video.id)`.
     def get_info(params = {}, info = nil)
       super
       @video = @info['video']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2012-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70222671050620 !ruby/object:Gem::Requirement
+  requirement: &70204420077060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70222671050620
+  version_requirements: *70204420077060
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70222671049860 !ruby/object:Gem::Requirement
+  requirement: &70204420071080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70222671049860
+  version_requirements: *70204420071080
 - !ruby/object:Gem::Dependency
   name: simple_oauth
-  requirement: &70222671049120 !ruby/object:Gem::Requirement
+  requirement: &70204420084940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -49,10 +49,10 @@ dependencies:
         version: '0.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70222671049120
+  version_requirements: *70204420084940
 - !ruby/object:Gem::Dependency
   name: multi_xml
-  requirement: &70222671048580 !ruby/object:Gem::Requirement
+  requirement: &70204420082980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -60,10 +60,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70222671048580
+  version_requirements: *70204420082980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70222671048060 !ruby/object:Gem::Requirement
+  requirement: &70204420081920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -71,10 +71,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70222671048060
+  version_requirements: *70204420081920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70222671047560 !ruby/object:Gem::Requirement
+  requirement: &70204420080800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -82,10 +82,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *70222671047560
+  version_requirements: *70204420080800
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70222671047100 !ruby/object:Gem::Requirement
+  requirement: &70204420078420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -93,7 +93,7 @@ dependencies:
         version: '2.1'
   type: :development
   prerelease: false
-  version_requirements: *70222671047100
+  version_requirements: *70204420078420
 description: This gem wraps the Flickr API with a nice object-oriented interface.
 email: janko.marohnic@gmail.com
 executables: []
@@ -102,6 +102,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -195,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4564017980712664051
+      hash: 3443351439038173602
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11