shrine-flickr 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4761bed9ab500b93b20b470079e6f250306e5022
-  data.tar.gz: 444f254394e988529d323b1f725b5f2e26338c77
+  metadata.gz: 93196d2074118c12e2a5c3e4ff0f4b08c6948b84
+  data.tar.gz: 9e1f351116746fc9868d10f6fffbbd15aefd7f29
 SHA512:
-  metadata.gz: 6d1b39cb97e7917b7b12edd804e0d826fd927090b7a0b17aa8987fc96171198f8cff1aa814e34a34058e9b0f6667454a89ffd7c727ef6e099596af5b86a1c6e8
-  data.tar.gz: cbaacdf09623d2f40cd2326ecf599ed0ccc579902e726ef100a117580b33d51cfe980de16a2cbda60ad47036c81928b7d574a467253a8950d38b9ed307766cbe
+  metadata.gz: f66a38504f2b7687dc543cc0d02fa65c76454d88ceb7c2b6e4f60e74e2878ed7b064d08cb4edabb51f668daa7fb5b08d92f38d9a01bedc92aa42430732a41f30
+  data.tar.gz: 3b4cec25c7aa76b78cb883a5b0071d1ded09c3d6519e1e8bc8349519779cabad4a81984a0b341c51ea22096246da31ca6c4f775d5892fc9911321c977e173384

data/README.md

@@ -28,62 +28,23 @@ access token, you can assign it to the storage:
 ```rb
 require "shrine/storage/flickr"
 
-Shrine::Storage::Flickr.new(access_token: ["key", "secret"])
+Shrine::Storage::Flickr.new(access_token: ["key", "secret"], user: "12345678@N01")
 ```
 
-### URL, width and height
+### URL
 
-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"] #=>
-# [
-#   {
-#     "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 the size name to `#url`, `#width` and `#height`:
+To generate source URLs, simply pass the name of the size to `#url`:
 
 ```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
-```
+user.avatar.url(size: :medium_500) # alternative notation
 
-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".
+user.avatar.url(size: "Original")
+user.avatar.url(size: :original) # alternative notation
 
-Note that when using storage-flickr you shouldn't load the `store_dimensions`
-plugin, because they're not compatible.
+All possible sizes are: "Square 75", "Thumbnail", "Square 150", "Small 240",
+"Small 320", "Medium 500", "Medium 640", "Medium 800", "Large 1024", and
+"Original".
 
 ### Album
 
@@ -109,12 +70,10 @@ key:
 ```rb
 class MyUploader < Shrine
   def extract_metadata(io, context)
-    metadata = super
-    metadata["flickr"] = {
+    super.update("flickr" => {
       title: io.original_filename,
       description: context[:record].description,
-    }
-    metadata
+    })
   end
 end
 ```
@@ -132,11 +91,11 @@ 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`:
+on another webiste, you should always link back to Flickr. This link will be
+generate when you don't pass any arguments to `#url`:
 
 ```erb
-<a href="<%= @user.avatar.flickr_url %>">
+<a href="<%= @user.avatar.url %>">
   <img src="<%= @user.avatar.url(size: "Small 320") %>">
 </a>
 ```

data/lib/shrine/storage/flickr.rb

@@ -1,13 +1,15 @@
 require "shrine"
 require "flickr-objects"
 require "down"
+require "net/http"
+require "uri"
 
 class Shrine
   module Storage
     class Flickr
       attr_reader :person, :flickr, :upload_options, :album
 
-      def initialize(upload_options: {}, user:, access_token:, album: nil)
+      def initialize(user:, access_token:, album: nil, upload_options: {})
         @flickr = ::Flickr.new(*access_token)
         @person = @flickr.people.find(user)
         @upload_options = upload_options
@@ -15,47 +17,49 @@ class Shrine
       end
 
       def upload(io, id, metadata = {})
-        options = metadata.delete("flickr") || {}
+        options = {title: metadata["filename"]}
         options.update(upload_options)
+        options.update(metadata.delete("flickr") || {})
 
         photo_id = flickr.upload(io, options)
-        id.replace(photo_id)
-        album.add_photo(id) if album
-
-        metadata["flickr_sizes"] = []
-        photo = photo(id).get_sizes!
-        photo.available_sizes.each do |size|
-          photo.size!(size)
-          metadata["flickr_sizes"] << {
-            "name"   => size,
-            "url"    => photo.source_url,
-            "width"  => photo.width,
-            "height" => photo.height,
-          }
-        end
+        album.add_photo(photo_id) if album
+
+        photo = photo(photo_id).get_info!
+        id.replace(generate_id(photo))
+
+        photo.attributes
       end
 
       def download(id)
-        raise NotImplementedError, "#download cannot be implemented"
+        Down.download(url(id, size: "Original"))
       end
 
       def open(id)
-        raise NotImplementedError, "#open cannot be implemented"
+        download(id)
+      end
+
+      def read(id)
+        Net::HTTP.get(URI.parse(url(id, size: "Original")))
       end
 
       def exists?(id)
-        !!photo(id).get_info!
+        !!photo(photo_id(id)).get_info!
       rescue ::Flickr::ApiError => error
         raise error if error.code != 1
         false
       end
 
       def delete(id)
-        photo(id).delete
+        photo(photo_id(id)).delete
       end
 
-      def url(id, **options)
-        raise NotImplementedError, "#url cannot be implemented"
+      def url(id, size: nil)
+        if size
+          size = size.to_s.tr("_", " ").capitalize if size.is_a?(Symbol)
+          "https://farm%s.staticflickr.com/%s/%s_%s%s.%s" % size_data(size, id)
+        else
+          "https://www.flickr.com/photos/#{person.id}/#{photo_id(id)}"
+        end
       end
 
       def clear!(confirm = nil)
@@ -72,64 +76,38 @@ class Shrine
       def photo(id)
         flickr.photos.find(id)
       end
-    end
-  end
-end
-
-class Shrine
-  module Plugins
-    module Flickr
-      module FileMethods
-        def download
-          if storage.is_a?(Storage::Flickr)
-            Down.download(url)
-          else
-            super
-          end
-        end
-
-        def url(**options)
-          if storage.is_a?(Storage::Flickr)
-            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
+      private
+
+      def size_data(size, id)
+        farm, server, photo_id, secret, original_secret, original_format = id.split(/\W/)
+
+        case size
+        when "Square 75"  then [farm, server, photo_id, secret, "_s", "jpg"]
+        when "Square 150" then [farm, server, photo_id, secret, "_q", "jpg"]
+        when "Thumbnail"  then [farm, server, photo_id, secret, "_t", "jpg"]
+        when "Small 240"  then [farm, server, photo_id, secret, "_m", "jpg"]
+        when "Small 320"  then [farm, server, photo_id, secret, "_n", "jpg"]
+        when "Medium 500" then [farm, server, photo_id, secret, "",   "jpg"]
+        when "Medium 640" then [farm, server, photo_id, secret, "_z", "jpg"]
+        when "Medium 800" then [farm, server, photo_id, secret, "_c", "jpg"]
+        when "Large 1024" then [farm, server, photo_id, secret, "_b", "jpg"]
+        when "Original"   then [farm, server, photo_id, original_secret, "_o", original_format]
+        when "Large 1600", "Large 2048"
+          raise Shrine::Error, "#{size.inspect} size isn't available"
+        else
+          raise Shrine::Error, "unknown size: #{size.inspect}"
         end
+      end
 
-        def io
-          if storage.is_a?(Storage::Flickr)
-            @io ||= download
-          else
-            super
-          end
-        end
+      def generate_id(photo)
+        "#{photo.farm}-#{photo.server}-#{photo.id}-#{photo.secret}" \
+        "-#{photo["originalsecret"]}.#{photo["originalformat"]}"
+      end
 
-        def flickr_sizes
-          metadata["flickr_sizes"]
-        end
+      def photo_id(id)
+        id.split("-").fetch(2)
       end
     end
   end
-
-  plugin Plugins::Flickr
 end

data/shrine-flickr.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-flickr"
-  gem.version       = "0.2.0"
+  gem.version       = "1.0.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.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flickr-objects