shrine-flickr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12ab499b1ff7996632ad117ae88b3942f34a5b18
+  data.tar.gz: 7e288b9df96f09379f15f25a2c16579e5c26aca5
+SHA512:
+  metadata.gz: 21bf0cd8d224802249b45135429a5a1e8c59e6e6043527200e0f13b08ecc07c03a99f2a14439592842cf713379a51c70d92e0f56053c1ec8f7ec1e797d9a6e75
+  data.tar.gz: db89dd5f8298879254fdf2d1a0f3df6b7222cc22d1fd3f79c4a937157e0c6105c0ab37ef19f08835900ddd5134782e478848229d318cd0dd96e41c06c9f15c0f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Janko Marohnić
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# Shrine::Flickr
+
+Provides [Flickr] storage for [Shrine].
+
+## Installation
+
+```ruby
+gem "shrine-flickr"
+```
+
+## Usage
+
+First you need to assign API key and shared secret to the Flickr client:
+
+```rb
+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:
+
+```rb
+require "shrine/storage/flickr"
+
+Shrine::Storage::Flickr.new(access_token: ["key", "secret"])
+```
+
+### URL options
+
+After the image is uploaded, available sizes and their URLs will be saved to
+file's `#metadata`:
+
+```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",
+#   }
+# }
+```
+
+You can pass in the name of the size as a URL option:
+
+```rb
+user.avatar.url(size: "Medium 500")
+user.avatar.url(size: :medium_500)
+```
+
+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".
+
+### Album
+
+You can choose to upload all your photos in an album by giving the album ID:
+
+```rb
+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:
+
+```rb
+Shrine::Storage::Flickr.new(upload_options: {hidden: 1})
+```
+
+Alternatively, if you would like to do it per-file, you can override
+`#extract_metadata` in your uploader, and add upload options under the "flickr"
+key:
+
+```rb
+class MyUploader < Shrine
+  def extract_metadata(io, context)
+    metadata = super
+    metadata["flickr"] = {
+      title: io.original_filename,
+      description: context[:record].description,
+    }
+    metadata
+  end
+end
+```
+
+### Clearing storage
+
+If you want to delete all photos from this storage, you can call `#clear!`:
+
+```rb
+flickr = Shrine::Storage::Flickr.new(access_token: ["...", "..."])
+# ...
+flickr.clear!(:confirm)
+```
+
+## Contributing
+
+First you need to create an `.env` file where you will store your credentials:
+
+```sh
+# .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:
+
+```sh
+$ bundle exec rake test
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)
+
+[Flickr]: https://www.flickr.com/
+[Shrine]: https://github.com/janko-m/shrine
+[`Flickr::OAuth`]: http://www.rubydoc.info/github/janko-m/flickr-objects/master/Flickr/OAuth
+[Flickr's upload API]: https://www.flickr.com/services/api/upload.api.html

data/lib/shrine/storage/flickr.rb

@@ -0,0 +1,120 @@
+require "shrine"
+require "flickr-objects"
+require "down"
+
+class Shrine
+  module Storage
+    class Flickr
+      attr_reader :person, :flickr, :upload_options, :album
+
+      def initialize(upload_options: {}, user:, access_token:, album: nil)
+        @flickr = ::Flickr.new(*access_token)
+        @person = @flickr.people.find(user)
+        @upload_options = upload_options
+        @album = @flickr.sets.find(album) if album
+      end
+
+      def upload(io, id, metadata = {})
+        options = metadata.delete("flickr") || {}
+        options.update(upload_options)
+
+        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|
+          metadata["flickr_sizes"][size] = photo.size!(size).source_url
+        end
+      end
+
+      def download(id)
+        raise NotImplementedError, "#download cannot be implemented"
+      end
+
+      def open(id)
+        raise NotImplementedError, "#open cannot be implemented"
+      end
+
+      def exists?(id)
+        !!photo(id).get_info!
+      rescue ::Flickr::ApiError => error
+        raise error if error.code != 1
+        false
+      end
+
+      def delete(id)
+        photo(id).delete
+      end
+
+      def url(id, **options)
+        raise NotImplementedError, "#url cannot be implemented"
+      end
+
+      def clear!(confirm = nil)
+        raise Shrine::Confirm unless confirm == :confirm
+        if album
+          album.photos.each(&:delete)
+        else
+          person.photos.each(&:delete)
+        end
+      end
+
+      protected
+
+      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(original_url)
+          else
+            super
+          end
+        end
+
+        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
+          else
+            super
+          end
+        end
+
+        private
+
+        def io
+          if storage.is_a?(Storage::Flickr)
+            @io ||= download
+          else
+            super
+          end
+        end
+
+        def original_url
+          flickr_sizes.fetch("Original")
+        end
+
+        def flickr_sizes
+          metadata["flickr_sizes"]
+        end
+      end
+    end
+  end
+
+  plugin Plugins::Flickr
+end

data/shrine-flickr.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name          = "shrine-flickr"
+  gem.version       = "0.1.0"
+
+  gem.required_ruby_version = ">= 2.1"
+
+  gem.summary      = "Provides Flickr storage for Shrine."
+  gem.homepage     = "https://github.com/janko-m/shrine-flickr"
+  gem.authors      = ["Janko Marohnić"]
+  gem.email        = ["janko.marohnic@gmail.com"]
+  gem.license      = "MIT"
+
+  gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-flickr.gemspec"]
+  gem.require_path = "lib"
+
+  gem.add_dependency "flickr-objects", ">= 0.6.1"
+  gem.add_dependency "down", ">= 1.0.3"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "shrine"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: shrine-flickr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flickr-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/shrine/storage/flickr.rb
+- shrine-flickr.gemspec
+homepage: https://github.com/janko-m/shrine-flickr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Provides Flickr storage for Shrine.
+test_files: []
+has_rdoc: