middleman-flickr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adfa3c7f93f4f65e6a8c59d87c5c3c206002c074
+  data.tar.gz: 7c9e4c6ae1da21d6d7db106162183ae60cf5dea3
+SHA512:
+  metadata.gz: 2f3e30cd443ec311f55fb94763944ff3bb3d3c87e68dd6d6d729f5d0558f5e0dfcccdcbafa1c527302e4a6b03b8b82fb678f2c80c09b645a797fe1a8372afdd4
+  data.tar.gz: 25494e70d11cef25c8623d7a50355b21e2fdfc5018d96312d0c97c55f6ac2b5eabe32b303de7206e3ce62c4ac74c404a528238ca9abb2a225697bdbd7b8c7466

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/AbcSize:
+  Max: 17
+Metrics/MethodLength:
+  Max: 15
+Naming/FileName:
+  Exclude:
+    - 'lib/middleman-flickr.rb'
+
+Style/Documentation:
+  Enabled: false
+

data/Gemfile

@@ -0,0 +1,19 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-flickr.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'aruba'
+  gem 'capybara'
+  gem 'cucumber'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,148 @@
+## Middleman Flickr
+
+`middleman-flickr` is an extension for the [Middleman] static site
+generator that adds some helper functions to allow embedding images from
+Flickr into your pages.
+
+**NOTE: Fetches a maximum of 500 photos in a set.**
+
+## Installation
+
+If you're just getting started, install the `middleman` gem and generate
+a new project:
+
+```
+gem install middleman
+middleman init MY_PROJECT
+```
+
+If you already have a Middleman project: Add `gem "middleman-flickr"`
+to your `Gemfile` and run `bundle install`.
+
+#### Environment Variables
+
+For this extension to work, it expects 4 environment variables setup:
+
+- `FLICKR_KEY`: Flickr API key
+- `FLICKR_SECRET`: Flickr API secret
+- `FLICKR_TOKEN`: Flickr OAuth token for the user
+- `FLICKR_TOKEN_SECREET`: Flickr OAuth token secret for the user
+
+An error **WILL** be raised if authentication with Flickr fails.
+
+## Helper Methods
+
+All helper methods added by this extension accepts configuration options
+for this extension, as well as any additional options for the Flickr
+API, if required, e.g.:
+
+```
+display_flickr_photoset: 'ID1', show_on_empty: false, per_page: 20
+```
+
+Here, `show_on_empty` is a config option for this extension, while
+`per_page` is an option for the Flickr API call being made. In this
+example, a maximum of 20 images will be returned, and HTML will not be
+added if no photos are returned.
+
+This extension adds the following helper methods for you:
+
+#### `get_flickr_images`
+
+```ruby
+get_flickr_images data: { photo: ['PID1', 'PID2'], photoset: ['PSID3'] }, options
+```
+
+Get a list of image URLs from Flickr for the given Photos and Photosets.
+This helper method can be used in your layouts etc. and can be styled
+anyway you like.
+
+#### `display_flickr`
+
+```ruby
+display_flickr data: { photo: ['PID1', 'PID2'], photoset: ['PSID3'] }, options
+```
+
+Add HTML markup for image URLs from Flickr for the given Photos and
+Photosets. Thumbnails will be used for the image, while a `lightbox`
+link is added for the large size image. Each image is wrapped in
+a `div.grid-item` CSS for ease of styling, which are further wrapped in
+a `div.grid` container. (Think: `masonry`)
+
+#### `display_flickr_photo`
+
+```ruby
+display_flickr_photo 'PID1', 'PID2', options
+```
+
+Add HTML for the given photos.
+
+#### `display_flickr_photoset`
+
+```ruby
+display_flickr_photoset 'PsID1', 'PsID2', options
+```
+
+Add HTML for the given photosets. A maximum of 500 photos per photoset
+can be returned, at the moment.
+
+## Configuration
+
+```
+activate :flickr do |conf|
+  conf.html_class = 'flickr-images'
+  conf.show_on_empty = true
+  conf.suppress_errors = -> (err) { puts err.message }
+end
+```
+
+### Options
+
+`html_class` option defines HTML class for `div` element that wraps the
+HTML generated by this extension. This may be useful for styling your
+gallery.
+
+`show_on_empty` option can be set to `false` to not output any HTML when
+no images could be found. You can, also, set this option to a `Proc`
+that generates the HTML in this case.
+
+`suppress_errors` option (default: `false`) can be used to suppress
+errors generated when querying Flickr API, e.g. when a Photo/set ID
+could not be found on Flickr. You can set this option to a `Proc` that
+consumes the `error` generated to do something more meaningful. By
+default, errors are raised/bubbled up.
+
+
+## Community
+
+The official community forum is available at: http://forum.middlemanapp.com
+
+## Bug Reports
+
+Github Issues are used for managing bug reports and feature requests. If
+you run into issues, please search the issues and submit new problems:
+https://github.com/middleman/middleman-blog/issues
+
+The best way to get quick responses to your issues and swift fixes to
+your bugs is to submit detailed bug reports, include test cases and
+respond to developer questions in a timely manner. Even better, if you
+know Ruby, you can submit [Pull
+Requests](https://help.github.com/articles/using-pull-requests)
+containing Cucumber Features which describe how your feature should work
+or exploit the bug you are submitting.
+
+## Tests / Build Status?
+
+**Coming up soon.**
+
+## Donate
+
+[Click here to lend your support to Middleman](https://spacebox.io/s/4dXbHBorC3)
+
+## License
+
+Copyright (c) 2018 Nikhil Gupta. MIT Licensed, see [LICENSE] for details.
+
+[middleman]: http://middlemanapp.com
+[travis]: http://travis-ci.org/statonjr/middleman-sitemap
+[LICENSE]: https://github.com/nikhgupta/middleman-flickr/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-flickr')

data/lib/middleman-flickr/extension.rb

@@ -0,0 +1,43 @@
+require 'middleman-core'
+
+# Middleman Flickr Extension namespace
+module Middleman
+  class Flickr < Extension
+    option :html_class, 'flickr-images', 'Class for div container for response.'
+    option :show_on_empty, true, 'Whether to embed markup when no photos are
+    returned? You can set this option to a Proc that renders HTML, instead.'
+    option :suppress_errors, false, 'Do not raise errors on missing photos! Set
+    this to a Proc if you like.'
+
+    expose_to_template :display_flickr, :get_flickr_images,
+                       :display_flickr_photo, :display_flickr_photoset
+
+    def initialize(app, options_hash = {}, &block)
+      super
+      require 'flickraw'
+      # require 'middleman-flickr/helpers'
+      # self.class.defined_helpers = [Middleman::Flickr::Helpers]
+      require 'middleman-flickr/scraper'
+    end
+
+    def get_flickr_images(opts = {})
+      data = options.to_h.merge(opts)
+      Middleman::Flickr::Scraper.new(data).scrape
+    end
+
+    def display_flickr(opts = {})
+      data = options.to_h.merge(opts)
+      Middleman::Flickr::Scraper.new(data).to_html
+    end
+
+    def display_flickr_photo(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      display_flickr opts.merge(data: { photo: args })
+    end
+
+    def display_flickr_photoset(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      display_flickr opts.merge(data: { photoset: args })
+    end
+  end
+end

data/lib/middleman-flickr/scraper.rb

@@ -0,0 +1,67 @@
+module Middleman
+  class Flickr
+    class Scraper
+      attr_reader :options
+
+      def initialize(data = {})
+        @options = data
+
+        FlickRaw.api_key = ENV['FLICKR_KEY']
+        FlickRaw.shared_secret = ENV['FLICKR_SECRET']
+        @flickr = FlickRaw::Flickr.new
+        @flickr.access_token = ENV['FLICKR_TOKEN']
+        @flickr.access_secret = ENV['FLICKR_TOKEN_SECRET']
+
+        @flickr.test.login # will raise error on auth failure!
+      end
+
+      def scrape
+        data = options.delete(:data)
+        data.map do |kind, ids|
+          ids.map { |id| request kind, id, options }.compact
+        end.compact.flatten(1).uniq
+      end
+
+      def to_html
+        html = scrape.map do |img|
+          <<-HTML
+          <div class='grid-item'>
+            <a href='#{img[:url]}' rel='lightbox'>
+              <img src='#{img[:thumb]}' class='lazyload flickr'/>
+            </a>
+          </div>"
+          HTML
+        end
+        html = html.any? ? "<div class='grid'>#{html.join}</div>" : nil
+
+        return "<div class='#{options[:html_class]}'>#{html}</div>" if html
+        return if !html && !(blk = options[:show_on_empty])
+
+        return blk.call(err) if blk.respond_to?(:call)
+        '<div class="alert alert-warning">Images not available.</div>'
+      end
+
+      def get_photoset(id, opts = {})
+        options = { photoset_id: id, extras: 'url_c,url_n', per_page: 500 }
+        options = options.merge(opts)
+        response = @flickr.photosets.getPhotos options
+        response.photo.map { |p| { thumb: p['url_n'], url: p['url_c'] } }
+      end
+
+      def get_photo(id, opts = {})
+        options = { photo_id: id, extras: 'url_c,url_n' }
+        options = options.merge(opts)
+        photo = @flickr.photos.getInfo options
+        { thumb: photo['url_n'], url: photo['url_c'] }
+      end
+
+      def request(kind, id, opts = {})
+        send("get_#{kind}", id, opts) if respond_to?("get_#{kind}")
+      rescue FlickRaw::FailedResponse => err
+        on_error = options[:suppress_errors]
+        raise unless on_error
+        on_error.call(err, kind, id) if on_error.respond_to?(:call)
+      end
+    end
+  end
+end

data/lib/middleman-flickr.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+Middleman::Extensions.register :flickr do
+  require 'middleman-flickr/extension'
+  Middleman::Flickr
+end

data/middleman-flickr.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-flickr'
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nikhil Gupta']
+  s.email       = ['me@nikhgupta.com']
+  s.homepage    = 'https://github.com/nikhgupta/middleman-flickr'
+  s.summary     = 'Middleman extension to display images from Flickr'
+  s.description = 'Middleman extension to display images from Flickr'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
+
+  s.add_runtime_dependency('middleman-core', ['>= 4.2.1'])
+  s.add_runtime_dependency('flickraw')
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: middleman-flickr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nikhil Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: flickraw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Middleman extension to display images from Flickr
+email:
+- me@nikhgupta.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-flickr.rb
+- lib/middleman-flickr/extension.rb
+- lib/middleman-flickr/scraper.rb
+- middleman-flickr.gemspec
+homepage: https://github.com/nikhgupta/middleman-flickr
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Middleman extension to display images from Flickr
+test_files:
+- features/support/env.rb