Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/shrine/storage
test
.gitignore
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
shrine-flickr.gemspec

README.md

Shrine::Storage::Flickr

Provides Flickr storage for Shrine.

Flickr is a photo sharing service which automatically generates different sizes of uploaded photos.

Installation

gem "shrine-flickr"

Usage

First you need to assign API key and shared secret to the Flickr client:

require "flickr-objects"

Flickr.configure do |config|
  config.api_key = "..."
  config.shared_secret = "..."
end

Afterwards you need to authenticate the account on which you want to upload photos, see Flickr::OAuth on how you can do that. After you've obtained the access token, you can assign it to the storage:

require "shrine/storage/flickr"

Shrine::Storage::Flickr.new(access_token: ["key", "secret"], user: "12345678@N01")

URL

To generate source URLs, simply pass the name of the size to #url:

user.avatar.url(size: "Medium 500")
user.avatar.url(size: :medium_500) # alternative notation

user.avatar.url(size: "Original")
user.avatar.url(size: :original) # alternative notation

All possible sizes are: "Square 75", "Thumbnail", "Square 150", "Small 240", "Small 320", "Medium 500", "Medium 640", "Medium 800", "Large 1024", and "Original".

Album

You can choose to upload all your photos in an album by giving the album ID:

Shrine::Storage::Flickr.new(album: "934891234")

Upload options

If you want to pass in additional attributes to the Flickr's upload API, you can pass in the :upload_options option:

Shrine::Storage::Flickr.new(upload_options: {hidden: 1})

You can also add upload options per-upload using the upload_options plugin:

class MyUploader < Shrine
  plugin :upload_options, store: ->(io, context) do
    {
      title: io.original_filename,
      description: context[:record].description,
    }
  end
end

Storing info

After photo is uploaded, additional information about the photo are requested from Flickr, in order to generate the ID. If you want to save those information to metadata, you can set :store_info:

Shrine::Storage::Flickr.new(store_info: true, **flickr_options)
photo = Photo.create(image: image_file)
photo.image.metadata["flickr"] #=>
# {
#   "id"             => "27169370821",
#   "secret"         => "ab85ddef07",
#   "server"         => "7754",
#   "farm"           => 8,
#   "dateuploaded"   => "1464170485",
#   "rotation"       => 0,
#   "originalsecret" => "e77ebc5126",
#   "originalformat" => "jpg",
#   "owner"          => {
#     "nsid"       => "78733179@N04",
#     "username"   => "@janko-m",
#     "realname"   => "Janko Marohnić",
#     "location"   => "Zagreb, Croatia",
#     "iconserver" => "8033",
#     "iconfarm"   => 9,
#     "path_alias" => nil
#   },
#   "title"       => {"_content"=>"image"},
#   "description" => {"_content"=>""},
#   "dates"       => {
#     "posted"           => "1464170485",
#     "taken"            => "2016-05-25 12:01:25",
#     "takengranularity" => 0,
#     "takenunknown"     => "1",
#     "lastupdate"       => "1464170486"
#   },
# }

Updating

If you want to update the title and description of the photo, you can use the #update method:

flickr = Shrine::Storage::Flickr.new(**flickr_options)
# ...
flickr.update(id, title: "Title", description: "Description")

Clearing storage

If you want to delete all photos from this storage, you can call #clear!:

flickr = Shrine::Storage::Flickr.new(**flickr_options)
# ...
flickr.clear!

Linking back

In Flickr's guidelines it states that if you're displaying photos from Flickr on another webiste, you should always link back to Flickr. This link will be generated when you don't pass any arguments to #url:

<a href="<%= @user.avatar.url %>">
  <img src="<%= @user.avatar.url(size: "Small 320") %>">
</a>

Contributing

First you need to create an .env file where you will store your credentials:

# .env
FLICKR_API_KEY="..."
FLICKR_SHARED_SECRET="..."
FLICKR_ACCESS_TOKEN_KEY="..."
FLICKR_ACCESS_TOKEN_SECRET="..."
FLICKR_USER="..." # The user ID, e.g. "94384331@N07"

Afterwards you can run the tests:

$ bundle exec rake test

License

MIT