flickxtractr 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d14c2c74500f2ea0d0d0715ca29c90777697dd2
+  data.tar.gz: a0125fb21234e9841c0eb04f8c7adb012dac2ea6
+SHA512:
+  metadata.gz: f442e047249610a262bd28cd2852d41508c13a880e6f8d313cb5b01d76d725bd7bde194034d1dee542926eec44e4978b9c125aebc3a1c42097fbe4772cf8ed59
+  data.tar.gz: c58b648570ff4718f1e61f6d3f44fabe33cd4320d97c87a6781c7de2ed8edb24a0dda32fb3b31f71a1d54aa506e17ff75200e7d22e732424ef444c215704eb4f

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 RootsRated Inc.
+
+MIT License
+
+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,37 @@
+# Flickxtractr
+
+A quick micro-service for downloading a Flickr image and attaching
+additional meta-data from a web scrape.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flickxtractr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flickxtractr
+
+Add dependent libraries:
+
+    $ brew install phantomjs
+    $ brew install exiftool
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/RootsRated/flickxtractr/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/Thorfile

@@ -0,0 +1,2 @@
+require 'flickxtractr'
+require 'flickxtractr/cli'

data/app/views/home.erb

@@ -0,0 +1,4 @@
+<form action="/extract" method="post">
+  <input name="url">
+  <input type="submit">
+</form>

data/assets/dotfile.yml

@@ -0,0 +1,5 @@
+bitly_access_token:
+ding_on_complete?: true
+output_dir: ./
+screenshot_dir: ./
+screenshot_public_url_prefix:

data/bin/flickxtractr

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'flickxtractr/cli'
+  Flickxtractr::CLI.start(ARGV.dup)
+rescue LoadError => e
+  abort "#{e.inspect} - perhaps you need to run using `bundle exec`?"
+end

data/config.ru

@@ -0,0 +1,2 @@
+require 'flickxtractr/app'
+run Flickxtractr::App

data/flickxtractr.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flickxtractr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flickxtractr"
+  spec.version       = Flickxtractr::VERSION
+  spec.authors       = ["RootsRated"]
+  spec.email         = ["developers@rootsrated.com"]
+  spec.summary       = %q{An image +meta extraction tool}
+  spec.description   = %q{An image +meta extraction tool}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{app lib}
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "bitly"
+  spec.add_dependency "capybara"
+  spec.add_dependency "hashie", "~> 3.4"
+  spec.add_dependency "mini_exiftool"
+  spec.add_dependency "poltergeist"
+  spec.add_dependency "sinatra"
+  spec.add_dependency "thor"
+end

data/lib/flickxtractr.rb

@@ -0,0 +1,11 @@
+require "flickxtractr/version"
+
+module Flickxtractr
+  autoload :App, 'flickxtractr/app'
+  autoload :Dotfile, 'flickxtractr/dotfile'
+  autoload :Extractr, 'flickxtractr/extractr'
+
+  def self.dotfile
+    @_dotfile ||= Dotfile.new
+  end
+end

data/lib/flickxtractr/app.rb

@@ -0,0 +1,16 @@
+require 'sinatra'
+
+module Flickxtractr
+  class App < Sinatra::Base
+    set :erb, :format => :html5
+    set :views, ['./app/views']
+
+    get '/' do
+      erb :home
+    end
+
+    post '/extract' do
+      "Extract!"
+    end
+  end
+end

data/lib/flickxtractr/cli.rb

@@ -0,0 +1,69 @@
+require 'flickxtractr'
+require 'thor'
+
+module Flickxtractr
+  class CLI < Thor
+    package_name 'Flickxtractr'
+
+    desc "install", "Install library dependencies"
+    def install
+      # Install Dependencies
+      %w{ exiftool phantomjs }.each do |dependency|
+        `brew install #{dependency}`
+      end
+
+      # Generate dotfile
+      Dotfile.install unless Dotfile.exists?
+    end
+
+    desc "extract URL", "Extract and enrich flickr image"
+    def extract(flickr_url)
+      print_extract_output("Loading", "Loading","Loading","Loading","Loading")
+
+      extractr = Flickxtractr::Extractr.new(flickr_url)
+      clear_output! && print_extract_output(
+        extractr.page_image_title,
+        extractr.page_image_description,
+        extractr.page_owner_name,
+        "Generating . . .",
+        "Generating . . .",
+      )
+
+      extractr.generate_image!
+
+      clear_output! && print_extract_output(
+        extractr.page_image_title,
+        extractr.page_image_description,
+        extractr.page_owner_name,
+        extractr.generated_image_file_name_with_extension,
+        extractr.generated_screenshot_file_name,
+      )
+
+      ding! if Flickxtractr.dotfile.ding_on_complete?
+    end
+
+    private
+
+    def print_extract_output(title, description, author, download, screenshot)
+      print <<-EOF
+        ---------------------------------------------------
+        Name               #{title}
+        Description        #{description}
+        Author             #{author}
+        - - - - - - - - - - - - - - - - - - - - - - - - - -
+        Download           #{download}
+        Screenshot         #{screenshot}
+        ---------------------------------------------------
+      EOF
+      STDOUT.flush
+    end
+
+    def clear_output!
+      8.times { print "\033[A", "\033[K" }
+    end
+
+    def ding!
+      print "\a"
+    end
+  end
+end

data/lib/flickxtractr/dotfile.rb

@@ -0,0 +1,36 @@
+require 'delegate'
+require 'hashie/mash'
+require 'yaml'
+
+module Flickxtractr
+  class Dotfile < SimpleDelegator
+
+    TEMPLATE_PATH = File.join(File.dirname(__FILE__), '..', '..', 'assets', 'dotfile.yml')
+    DOTFILE_FILENAME = ".flickxtractr"
+
+    class << self
+      def install
+        FileUtils.copy TEMPLATE_PATH, path
+      end
+
+      def path
+        File.join(user_path, DOTFILE_FILENAME)
+      end
+
+      def exists?
+        File.exist? path
+      end
+
+      private
+
+      def user_path
+        Dir.home rescue ENV.fetch('HOME', "/")
+      end
+    end
+
+    def initialize
+      dotfile_path = File.exist?(self.class.path) ? self.class.path : TEMPLATE_PATH
+      super Hashie::Mash.new YAML.load_file(dotfile_path)
+    end
+  end
+end

data/lib/flickxtractr/extractr.rb

@@ -0,0 +1,140 @@
+require 'bitly'
+require 'capybara'
+require 'capybara/dsl'
+require 'capybara/poltergeist'
+require 'mini_exiftool'
+
+module Flickxtractr
+  class Extractr
+    include Capybara::DSL
+
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+
+      initialize_capybara!
+    end
+
+    def generate_image!
+      generate_page_screenshot!
+
+      image_file = generate_image_file!
+      apply_meta_from_extract!(image_file)
+    end
+
+    def page_image_uri
+      @_page_image_uri ||= begin
+        find(:css, "div.download a").click
+        within("div.download-dialog-tooltip ul.sizes") do
+          URI(find(:xpath, "./li[@class='Original']/a")[:href])
+        end
+      end
+    end
+
+    def generated_image_file_name
+      "#{Date.today.strftime("%Y%m%d")}_#{generated_image_slug}"
+    end
+
+    def generated_image_file_name_with_extension
+      "#{generated_image_file_name}.#{page_image_uri.path.match(/\.(.+?)\z/)[1]}"
+    end
+
+    def generated_screenshot_file_name
+      "#{generated_image_file_name}_screenshot.png"
+    end
+
+    def generated_image_slug
+      page_image_title.gsub(/\W+/, '-').downcase.gsub(/\A-|-\Z/, '')
+    end
+
+    def page_image_title
+      find(:css, "h1.photo-title").text
+    end
+
+    def page_image_description
+      all(:css, "h2.photo-desc p").collect(&:text).join("\n")
+    end
+
+    def page_image_keywords
+      tag_links = all(:css, "ul.tags-list li a")
+      tag_links.collect { |a| a[:title] unless a.has_selector?(".remove-tag") }.compact.join("; ")
+    end
+
+    def page_owner_name
+      find(:css, "div.attribution-info a.owner-name.truncate").text
+    end
+
+    def page_owner_profile
+      "https://www.flickr.com#{find(:css, "div.attribution-info a.owner-name.truncate")[:href]}"
+    end
+
+    private
+
+    def initialize_capybara!
+      Capybara.current_driver = :poltergeist
+      Capybara.javascript_driver = :poltergeist
+      visit(url)
+    end
+
+    def generate_image_file!
+      File.open(File.join(Flickxtractr.dotfile.output_dir, generated_image_file_name_with_extension), "wb").tap do |f|
+        Net::HTTP.start(page_image_uri.host) do |http|
+          begin
+            http.request_get(page_image_uri.path) do |resp|
+              resp.read_body do |segment|
+                f.write(segment)
+              end
+            end
+          ensure
+            f.close
+          end
+        end
+      end
+    end
+
+    def generate_page_screenshot!
+      page.save_screenshot(File.join(Flickxtractr.dotfile.screenshot_dir, generated_screenshot_file_name), full: true)
+    end
+
+    def apply_meta_from_extract!(image_file)
+      MiniExiftool.new(image_file.path).tap do |rmi|
+        image_meta.each { |k, v| rmi[k] = v }
+        rmi.save!
+      end
+    end
+
+    def image_meta
+      {
+        "Headline"     => page_image_title,
+        "Description"  => page_image_description,
+        "Keywords"     => page_image_keywords,
+        "Credit"       => page_owner_name,
+        "Credit Line"  => page_owner_name,
+        "Source"       => shortened_url_for(url).short_url,
+        "Instructions" => shortened_url_for(public_screenshot_url).short_url,
+      }
+    end
+
+    def public_screenshot_url
+      "#{Flickxtractr.dotfile.screenshot_public_url_prefix}/#{generated_screenshot_file_name}"
+    end
+
+    def shortened_url_for(url_to_shorten)
+      self.class.bitly_client.shorten(url_to_shorten)
+    end
+
+    def self.bitly_client
+      @_bitly_client ||= begin
+        Bitly.use_api_version_3
+
+        Bitly.configure do |config|
+          config.api_version  = 3
+          config.access_token = Flickxtractr.dotfile.bitly_access_token
+        end
+
+        Bitly.client
+      end
+    end
+  end
+end

data/lib/flickxtractr/version.rb

@@ -0,0 +1,3 @@
+module Flickxtractr
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: flickxtractr
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- RootsRated
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bitly
+  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'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: mini_exiftool
+  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'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: An image +meta extraction tool
+email:
+- developers@rootsrated.com
+executables:
+- flickxtractr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Thorfile
+- app/views/home.erb
+- assets/dotfile.yml
+- bin/flickxtractr
+- config.ru
+- flickxtractr.gemspec
+- lib/flickxtractr.rb
+- lib/flickxtractr/app.rb
+- lib/flickxtractr/cli.rb
+- lib/flickxtractr/dotfile.rb
+- lib/flickxtractr/extractr.rb
+- lib/flickxtractr/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- app
+- 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.4.8
+signing_key: 
+specification_version: 4
+summary: An image +meta extraction tool
+test_files: []