flickr 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a84720ee6e0bdd7c794e4a2ea48948ab7afd2c6319e3df9d87f7abac40d507
-  data.tar.gz: 5b2499fa37c7b1008679f2132558a06f2c47a40f036b82363ef050d5ad57df0e
+  metadata.gz: 65cb1e57a0b7ff7ce2f05da2b7e2bcf910c417b79e66d1ad5b32bd4f3c1c8ca7
+  data.tar.gz: 2fe80a2e1db250bf7f8e297da921891e5baa97f106186fe5876f698c82cfc10e
 SHA512:
-  metadata.gz: 64cdc4ad80d21472105030ef54ab2f57681d6521324f23092036c36ba3856911787b799295ef0857449fed4bd33fd6900333806f741034e1464ad0137509e84b
-  data.tar.gz: 9f55e63e17f5ca0bee74a37707203e58a35c4776f48ae9f0048b876eb2123346c7b1b0d4a68755962de767bb83ea0426257f8eddc8aa922f680e936afcc3350c
+  metadata.gz: a494a33e313ab2f06a971f2ae4afaab55a75e7221f6a24dd9484fd59b0c04830f4b2e74f3434d121b1d6a072560eed70c81732863e98dc86dcef556fb3781edc
+  data.tar.gz: 80b7dca89da88c74055fcbba17ff858965d8ae075e036e0a84fc9d97831babaddfb6210e0e46ef4855e9a1934415d5fca489e02dd7bcb4047649a99488afec55

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/html/
+/pkg/
+/spec/reports/
+/tmp/
+/flickr-*.gem

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - jruby
+script:
+  - bundle exec rake
+  - bundle exec bundle-audit check --update

data/CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.0.2 - 2019-06-05
+### Added
+- Updated upload and replace endpoints
 
 ## 2.0.1 - 2019-03-17
 ### Added

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,251 @@
+# Flickr [![Build Status](https://travis-ci.org/cyclotron3k/flickr.svg?branch=master)](https://travis-ci.org/cyclotron3k/flickr)
+
+Flickr (formerly FlickRaw) is a library to access the [Flickr](https://flickr.com) API in a simple way.
+It maps exactly the methods described in [the official API documentation](https://www.flickr.com/services/api/).
+It also tries to present the data returned in a simple and intuitive way.
+The methods are fetched from Flickr when loading the library by using introspection capabilities.
+So it is always up-to-date with regards to new methods added by Flickr.
+
+The github repository: https://github.com/cyclotron3k/flickr
+
+# Upgrading from FlickRaw?
+
+If you're upgrading from FlickRaw 0.9.x there are a few breaking changes to be aware of:
+*   Instantiate a new object with `client = Flickr.new` instead of `FlickRaw::Flickr.new`.
+*   The global `flickr` variable is no longer created.
+*   Local caching of the Flickr API specification is no longer achieved with a separate gem.
+
+
+# Installation
+Type this in a console (you might need to be superuser)
+
+    gem install flickr
+
+This will recreate the documentation by fetching the method descriptions from Flickr and then virtually plugging them in standard rdoc documentation.
+
+    $ cd flickr
+    $ rake rdoc
+
+# Features
+
+*   Minimal dependencies
+*   Complete support of Flickr API. This doesn't require an update of the library
+*   Ruby syntax similar to the Flickr API
+*   Flickr authentication
+*   HTTPS Support
+*   Photo upload
+*   Proxy support
+*   Flickr URLs helpers
+
+
+# Usage
+
+## Getting started
+
+To use the Flickr API, you must first obtain an API key and shared secret from Flickr.
+You can do this by logging in to Flickr and creating an application [here](https://www.flickr.com/services/apps/create/apply).
+API keys are usually granted automatically and instantly.
+
+```ruby
+require 'flickr'
+
+# The credentials can be provided as parameters:
+
+flickr = Flickr.new "YOUR API KEY", "YOUR SHARED SECRET"
+
+# Alternatively, if the API key and Shared Secret are not provided, Flickr will attempt to read them
+# from environment variables:
+# ENV['FLICKR_API_KEY']
+# ENV['FLICKR_SHARED_SECRET']
+
+flickr = Flickr.new
+
+# Flickr will raise an error if either parameter is not explicitly provided, or available via environment variables.
+```
+
+## Simple
+
+```ruby
+list   = flickr.photos.getRecent
+
+id     = list[0].id
+secret = list[0].secret
+info   = flickr.photos.getInfo :photo_id => id, :secret => secret
+
+puts info.title           # => "PICT986"
+puts info.dates.taken     # => "2006-07-06 15:16:18"
+
+sizes = flickr.photos.getSizes :photo_id => id
+
+original = sizes.find { |s| s.label == 'Original' }
+puts original.width       # => "800" -- may fail if they have no original marked image
+```
+
+## Authentication
+
+```ruby
+token = flickr.get_request_token
+auth_url = flickr.get_authorize_url(token['oauth_token'], :perms => 'delete')
+
+puts "Open this url in your browser to complete the authentication process: #{auth_url}"
+puts "Copy here the number given when you complete the process."
+verify = gets.strip
+
+begin
+  flickr.get_access_token(token['oauth_token'], token['oauth_token_secret'], verify)
+  login = flickr.test.login
+  puts "You are now authenticated as #{login.username} with token #{flickr.access_token} and secret #{flickr.access_secret}"
+rescue Flickr::FailedResponse => e
+  puts "Authentication failed : #{e.msg}"
+end
+```
+
+If the user has already been authenticated, you can reuse the access token and access secret:
+
+```ruby
+flickr.access_token = "... Your access token ..."
+flickr.access_secret = "... Your access secret ..."
+
+# From here you are logged:
+login = flickr.test.login
+puts "You are now authenticated as #{login.username}"
+```
+
+If you need to have several users authenticated at the same time in your application (ex: a public web application) you need to create separate Flickr objects since it keeps the authentication data internally.
+
+```ruby
+flickr = Flickr.new
+```
+
+## Upload
+
+```ruby
+PHOTO_PATH = 'photo.jpg'
+
+# You need to be authenticated to do that, see the previous examples.
+flickr.upload_photo PHOTO_PATH, :title => "Title", :description => "This is the description"
+```
+
+## Caching
+
+The first time the Flickr object is instantiated, it will download the current Flickr API definition and dynamically create all the required classes and
+objects.
+This is how the gem remains up-to-date without requiring updates.
+
+Unfortunately this adds a significant delay to startup, but the Flickr gem can be configured to cache the API definition to a local file.
+Just set a file location before the Flickr class is instantiated:
+
+```ruby
+Flickr.cache = '/tmp/flickr-api.yml'
+flickr = Flickr.new
+```
+
+## Proxy
+
+```ruby
+require 'flickr'
+Flickr.proxy = "https://user:pass@proxy.example.com:3129/"
+```
+
+### Server Certificate Verification
+
+Server certificate verification is enabled by default. If you don't want to check the server certificate:
+
+```ruby
+require 'flickr'
+Flickr.check_certificate = false
+```
+
+### CA Certificate File Path
+
+`OpenSSL::X509::DEFAULT_CERT_FILE` is used as a CA certificate file. If you want to change the path:
+
+```ruby
+require 'flickr'
+Flickr.ca_file = '/path/to/cacert.pem'
+```
+
+You can also specify a path to a directory with a number of certifications:
+
+```ruby
+Flickr.ca_path = '/path/to/certificates'
+```
+
+## Flickr URL Helpers
+
+There are some helpers to build Flickr urls:
+
+### url, url_m, url_s, url_t, url_b, url_z, url_q, url_n, url_c, url_o
+
+```ruby
+# url_s : Square
+# url_q : Large Square
+# url_t : Thumbnail
+# url_m : Small
+# url_n : Small 320
+# url   : Medium
+# url_z : Medium 640
+# url_c : Medium 800
+# url_b : Large
+# url_o : Original
+
+info = flickr.photos.getInfo(:photo_id => "3839885270")
+Flickr.url_b(info) # => "https://farm3.static.flickr.com/2485/3839885270_6fb8b54e06_b.jpg"
+```
+
+### url_profile
+
+```ruby
+info = flickr.photos.getInfo(:photo_id => "3839885270")
+Flickr.url_profile(info) # => "https://www.flickr.com/people/41650587@N02/"
+```
+
+### url_photopage
+
+```ruby
+info = flickr.photos.getInfo(:photo_id => "3839885270")
+Flickr.url_photopage(info) # => "https://www.flickr.com/photos/41650587@N02/3839885270"
+```
+
+### url_photoset, url_photosets
+
+```ruby
+info = flickr.photos.getInfo(:photo_id => "3839885270")
+Flickr.url_photosets(info) # => "https://www.flickr.com/photos/41650587@N02/sets/"
+```
+
+### url_short, url_short_m, url_short_s, url_short_t
+
+```ruby
+info = flickr.photos.getInfo(:photo_id => "3839885270")
+Flickr.url_short(info) # => "https://flic.kr/p/6Rjq7s"
+```
+
+### url_photostream
+
+```ruby
+info = flickr.photos.getInfo(:photo_id => "3839885270")
+Flickr.url_photostream(info) # => "https://www.flickr.com/photos/41650587@N02/"
+```
+
+## Troubleshooting
+
+If you see an error like this:
+
+    There was an error while loading `flickr.gemspec`: invalid byte sequence in US-ASCII. Bundler cannot continue.
+
+It probably means you're trying to use `Flickr` in a default Ruby docker container. The official Ruby Docker image does not specify a locale, and so it defaults to `US-ASCII`. This causes issues because the `Flickr` gem includes `UTF-8` encoded characters.
+
+If you were affected by this problem, you will need to set your container's environment variables to something like the following:
+
+    export LANG=C.UTF-8
+    export LC_ALL=C.UTF-8
+    export LC_CTYPE=C.UTF-8
+
+A popular alternative to `C.UTF-8` would be `en_US.UTF-8`
+
+Also please consider adding a +1 to [this issue](https://github.com/docker-library/ruby/issues/45) on GitHub.
+
+## Examples
+
+See the *examples* directory to find more examples.

data/flickr.gemspec

@@ -0,0 +1,33 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'flickr/version'
+
+Gem::Specification.new do |s|
+  s.name     = "flickr"
+  s.summary  = "Flickr (formerly FlickRaw) is full-featured client for the Flickr API"
+  s.authors  = ["Mael Clerambault", "Aidan Samuel"]
+  s.email    = "aidan.samuel@gmail.com"
+  s.license  = "MIT"
+  s.version  = Flickr::VERSION
+  s.homepage = "https://github.com/cyclotron3k/flickr"
+  s.files    = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  s.metadata = {
+    "bug_tracker_uri"   => "https://github.com/cyclotron3k/flickr/issues",
+    "changelog_uri"     => "https://github.com/cyclotron3k/flickr/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/cyclotron3k/flickr/blob/v#{Flickr::VERSION}/README.md",
+    "source_code_uri"   => "https://github.com/cyclotron3k/flickr",
+  }
+
+  s.add_development_dependency "rake", "~> 12.0"
+  s.add_development_dependency "pry", "~> 0.11"
+  s.add_development_dependency "nokogiri", "~> 1.0"
+  s.add_development_dependency "webmock", "~> 2.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "bundler-audit", "~> 0.6"
+  s.add_development_dependency "vcr", "~> 4.0"
+
+  s.required_ruby_version = '>= 2.3'
+
+end

data/flickr_rdoc.rb

@@ -55,14 +55,14 @@ module RDoc
         m.singleton = false
 
         m.start_collecting_tokens
-        m.add_token FakedToken.new( %{
-# Generated automatically from flickr api
-  def #{name}(*args)
-    @flickr.call '#{flickr_method}', *args
-  end
-} )
+        m.add_token FakedToken.new(<<~HEREDOC)
+          # Generated automatically from flickr api
+            def #{name}(*args)
+              @flickr.call '#{flickr_method}', *args
+            end
+        HEREDOC
         doc.add_method m
-         @stats.add_method m
+        @stats.add_method m
       }
     end
 

data/lib/flickr.rb

@@ -10,14 +10,15 @@ require 'flickr/response_list'
 
 class Flickr
 
-  USER_AGENT                 = "Flickr/#{VERSION} (+https://github.com/hanklords/flickraw)".freeze
+  USER_AGENT                 = "Flickr/#{VERSION} (+https://github.com/cyclotron3k/flickr)".freeze
   END_POINT                  = 'https://api.flickr.com/services'.freeze
+  UPLOAD_END_POINT           = 'https://up.flickr.com/services'.freeze
   FLICKR_OAUTH_REQUEST_TOKEN = (END_POINT + '/oauth/request_token').freeze
   FLICKR_OAUTH_AUTHORIZE     = (END_POINT + '/oauth/authorize').freeze
   FLICKR_OAUTH_ACCESS_TOKEN  = (END_POINT + '/oauth/access_token').freeze
   REST_PATH                  = (END_POINT + '/rest/').freeze
-  UPLOAD_PATH                = (END_POINT + '/upload/').freeze
-  REPLACE_PATH               = (END_POINT + '/replace/').freeze
+  UPLOAD_PATH                = (UPLOAD_END_POINT + '/upload/').freeze
+  REPLACE_PATH               = (UPLOAD_END_POINT + '/replace/').freeze
   PHOTO_SOURCE_URL           = 'https://farm%s.staticflickr.com/%s/%s_%s%s.%s'.freeze
   URL_PROFILE                = 'https://www.flickr.com/people/'.freeze
   URL_PHOTOSTREAM            = 'https://www.flickr.com/photos/'.freeze
@@ -54,7 +55,7 @@ class Flickr
   # This is the central method. It does the actual request to the Flickr server.
   #
   # Raises FailedResponse if the response status is _failed_.
-  def call(req, args={}, &block)
+  def call(req, args = {}, &block)
     oauth_args = args.delete(:oauth) || {}
     http_response = @oauth_consumer.post_form(REST_PATH, @access_secret, {:oauth_token => @access_token}.merge(oauth_args), build_args(args, req))
     process_response(req, http_response.body)
@@ -88,7 +89,7 @@ class Flickr
   #  flickr.upload_photo '/path/to/the/photo', :title => 'Title', :description => 'This is the description'
   #
   # See https://www.flickr.com/services/api/upload.api.html for more information on the arguments.
-  def upload_photo(file, args={})
+  def upload_photo(file, args = {})
     upload_flickr(UPLOAD_PATH, file, args)
   end
 
@@ -97,7 +98,7 @@ class Flickr
   #  flickr.replace_photo '/path/to/the/photo', :photo_id => id
   #
   # See https://www.flickr.com/services/api/replace.api.html for more information on the arguments.
-  def replace_photo(file, args={})
+  def replace_photo(file, args = {})
     upload_flickr(REPLACE_PATH, file, args)
   end
 
@@ -157,7 +158,7 @@ class Flickr
 
   end
 
-  def build_args(args={}, method_name=nil)
+  def build_args(args = {}, method_name = nil)
     args['method'] = method_name if method_name
     args.merge('format' => 'json', 'nojsoncallback' => '1')
   end
@@ -189,7 +190,7 @@ class Flickr
     end
   end
 
-  def upload_flickr(method, file, args={})
+  def upload_flickr(method, file, args = {})
     oauth_args = args.delete(:oauth) || {}
     args = build_args(args)
     if file.respond_to? :read
@@ -242,17 +243,18 @@ class Flickr
       r
     end
 
-    def url(r);   PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret,   '', 'jpg'] end
-    def url_m(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_m', 'jpg'] end
-    def url_s(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_s', 'jpg'] end
-    def url_t(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_t', 'jpg'] end
-    def url_b(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_b', 'jpg'] end
-    def url_z(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_z', 'jpg'] end
-    def url_q(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_q', 'jpg'] end
-    def url_n(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_n', 'jpg'] end
-    def url_c(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_c', 'jpg'] end
-    def url_h(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_h', 'jpg'] end
-    def url_k(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, '_k', 'jpg'] end
+    def gen_url(r, type)
+      PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.secret, type, 'jpg']
+    end
+
+    def url(r); gen_url(r, '') end
+
+    %W{m s t b z q n c h k}.each do |chr|
+      define_method "url_#{chr}" do |r|
+        gen_url r, "_#{chr}"
+      end
+    end
+
     def url_o(r); PHOTO_SOURCE_URL % [r.farm, r.server, r.id, r.originalsecret, '_o', r.originalformat] end
     def url_profile(r); URL_PROFILE + (r.owner.respond_to?(:nsid) ? r.owner.nsid : r.owner) + '/' end
     def url_photopage(r); url_photostream(r) + r.id end