shrine-flickr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12ab499b1ff7996632ad117ae88b3942f34a5b18
-  data.tar.gz: 7e288b9df96f09379f15f25a2c16579e5c26aca5
+  metadata.gz: 4761bed9ab500b93b20b470079e6f250306e5022
+  data.tar.gz: 444f254394e988529d323b1f725b5f2e26338c77
 SHA512:
-  metadata.gz: 21bf0cd8d224802249b45135429a5a1e8c59e6e6043527200e0f13b08ecc07c03a99f2a14439592842cf713379a51c70d92e0f56053c1ec8f7ec1e797d9a6e75
-  data.tar.gz: db89dd5f8298879254fdf2d1a0f3df6b7222cc22d1fd3f79c4a937157e0c6105c0ab37ef19f08835900ddd5134782e478848229d318cd0dd96e41c06c9f15c0f
+  metadata.gz: 6d1b39cb97e7917b7b12edd804e0d826fd927090b7a0b17aa8987fc96171198f8cff1aa814e34a34058e9b0f6667454a89ffd7c727ef6e099596af5b86a1c6e8
+  data.tar.gz: cbaacdf09623d2f40cd2326ecf599ed0ccc579902e726ef100a117580b33d51cfe980de16a2cbda60ad47036c81928b7d574a467253a8950d38b9ed307766cbe

data/README.md

@@ -31,33 +31,60 @@ require "shrine/storage/flickr"
 Shrine::Storage::Flickr.new(access_token: ["key", "secret"])
 ```
 
-### URL options
+### URL, width and height
 
-After the image is uploaded, available sizes and their URLs will be saved to
-file's `#metadata`:
+After the image is uploaded, URLs, widths and heighs of all sizes will be saved
+to "flickr_sizes" metadata key:
 
 ```rb
-user.avatar.metadata #=>
-# {
-#   "flickr_sizes" => {
-#     "Square 75" => "https://farm6.staticflickr.com/5687/23578693711_ab9745cfd0_s.jpg",
-#     "Thumbnail" => "https://farm6.staticflickr.com/5687/23578693711_ab9745cfd0_t.jpg",
-#     "Original" => "https://farm6.staticflickr.com/5687/23578693711_0bf01bb96a_o.jpg",
+user.avatar.metadata["flickr_sizes"] #=>
+# [
+#   {
+#     "name" => "Square 75",
+#     "url" => "https://farm6.staticflickr.com/5706/23367159280_36d62093cf_s.jpg",
+#     "width" => 75,
+#     "height" => 75
+#   },
+#   {
+#     "name" => "Thumbnail",
+#     "url" => "https://farm6.staticflickr.com/5706/23367159280_36d62093cf_t.jpg",
+#     "width" => 100,
+#     "height" => 67
+#   },
+#   {
+#     "name" => "Original",
+#     "url" => "https://farm6.staticflickr.com/5706/23367159280_499ddf155e_o.jpg",
+#     "width" => 100,
+#     "height" => 67
 #   }
-# }
+# ]
 ```
 
-You can pass in the name of the size as a URL option:
+You can pass the size name to `#url`, `#width` and `#height`:
 
 ```rb
 user.avatar.url(size: "Medium 500")
+user.avatar.width(size: "Thumbnail")
+user.avatar.height(size: "Small 320")
+
+# alternative notation
 user.avatar.url(size: :medium_500)
+user.avatar.width(size: :thumbnail)
+user.avatar.height(size: :small_320)
+
+# defaults to "Original"
+user.avatar.url
+user.avatar.width
+user.avatar.height
 ```
 
 All possible sizes are: "Square 75", "Thumbnail", "Square 150", "Small 240",
 "Small 320", "Medium 500", "Medium 640", "Medium 800", "Large 1024", "Large
 1600", "Large 2048" and "Original".
 
+Note that when using storage-flickr you shouldn't load the `store_dimensions`
+plugin, because they're not compatible.
+
 ### Album
 
 You can choose to upload all your photos in an album by giving the album ID:
@@ -102,6 +129,18 @@ flickr = Shrine::Storage::Flickr.new(access_token: ["...", "..."])
 flickr.clear!(:confirm)
 ```
 
+### 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. For that you can
+use `#flickr_url`:
+
+```erb
+<a href="<%= @user.avatar.flickr_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:

data/lib/shrine/storage/flickr.rb

@@ -22,10 +22,16 @@ class Shrine
         id.replace(photo_id)
         album.add_photo(id) if album
 
-        metadata["flickr_sizes"] = {}
+        metadata["flickr_sizes"] = []
         photo = photo(id).get_sizes!
         photo.available_sizes.each do |size|
-          metadata["flickr_sizes"][size] = photo.size!(size).source_url
+          photo.size!(size)
+          metadata["flickr_sizes"] << {
+            "name"   => size,
+            "url"    => photo.source_url,
+            "width"  => photo.width,
+            "height" => photo.height,
+          }
         end
       end
 
@@ -76,7 +82,7 @@ class Shrine
       module FileMethods
         def download
           if storage.is_a?(Storage::Flickr)
-            Down.download(original_url)
+            Down.download(url)
           else
             super
           end
@@ -84,19 +90,32 @@ class Shrine
 
         def url(**options)
           if storage.is_a?(Storage::Flickr)
-            if size = options[:size]
-              size = size.to_s.tr("_", " ").capitalize if size.is_a?(Symbol)
-              flickr_sizes.fetch(size)
-            else
-              original_url
-            end
+            size_attribute("url", **options)
           else
             super
           end
         end
 
+        def width(**options)
+          size_attribute("width", **options)
+        end
+
+        def height(**options)
+          size_attribute("height", **options)
+        end
+
+        def flickr_url
+          "https://www.flickr.com/photos/#{storage.person.id}/#{id}"
+        end
+
         private
 
+        def size_attribute(key, size: "Original")
+          size = size.to_s.tr("_", " ").capitalize if size.is_a?(Symbol)
+          hash = flickr_sizes.find { |hash| hash["name"] == size }
+          hash.fetch(key) if hash
+        end
+
         def io
           if storage.is_a?(Storage::Flickr)
             @io ||= download
@@ -105,10 +124,6 @@ class Shrine
           end
         end
 
-        def original_url
-          flickr_sizes.fetch("Original")
-        end
-
         def flickr_sizes
           metadata["flickr_sizes"]
         end

data/shrine-flickr.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-flickr"
-  gem.version       = "0.1.0"
+  gem.version       = "0.2.0"
 
   gem.required_ruby_version = ">= 2.1"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-flickr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flickr-objects