paperclip-location 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75420e6a446f612b56b79ebc87a8cd3bcf35d58e
+  data.tar.gz: 08346e2ada1feda7fa6ec4bbd58ae9e3947e5546
+SHA512:
+  metadata.gz: 6dcd3f47db40ac085d342fc9c4f16cfda48f2d468f6a01432f3d7b7c00f2598031ba48c49e3f506e84f9a02240ea7221df2629d113e0df1687a7263d456f07b9
+  data.tar.gz: 494ebfbebe92985f077136e27d5715a196d6021c018d2a60617f42bfd1648975be8f4e1949082f79ab75b5597a48a85923e8e149b0dc9a02a6800cd77334a81b

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - jruby-head
+notifications:
+  email: false
+script:
+- bundle exec rake --trace spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sean Doyle
+
+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,62 @@
+# Location Paperclip::Processor
+
+[![Build Status](https://travis-ci.org/seanpdoyle/paperclip-location.png)](https://travis-ci.org/seanpdoyle/paperclip-location)
+
+Extracts GeoLocation data from an image during Paperclip processing
+and attaches it to the associated model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+  gem 'paperclip-location', github: 'seanpdoyle/paperclip-location'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-location
+
+## Usage
+
+Use it like any other `Paperclip::Processor`
+
+```ruby
+class PlaceOfInterest < ActiveRecord::Base
+
+  has_attached_file :photo, styles: { large: '600x600#' },
+                    processors: [:thumbnail, :location]
+
+end
+```
+
+The processor expects that the model in question has the following:
+
+* `location_locked` - a boolean flag to determine if the location has been manually overridden
+* `lat` - a float representing the latitude
+* `lng` - a float representing the longitude
+
+If you don't have either, run a migration to add them
+
+```ruby
+class AddLocationToModel < ActiveRecord::Migration
+  def self.change
+    add_column :model, :location_locked, :boolean, default: false, null: false
+    add_column :model, :lat, :float
+    add_column :model, :lng, :float
+  end
+end
+```
+
+These field names will be customizable in future versions
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/paperclip/location.rb

@@ -0,0 +1,2 @@
+require 'paperclip/location/processor'
+require 'paperclip/location/railtie' if defined?(Rails)

data/lib/paperclip/location/processor.rb

@@ -0,0 +1,30 @@
+require 'paperclip'
+require 'exifr'
+
+module Paperclip
+  module Location
+    class Processor < Paperclip::Processor
+
+    delegate :location_locked?, to: :instance, allow_nil: true
+    delegate :instance, to: :attachment, allow_nil: true
+    delegate :gps, to: :exif
+
+    def make
+      if can_process?
+        instance.lat = gps.latitude
+        instance.lng = gps.longitude
+      end
+      file
+    end
+
+    private
+      def can_process?
+        !location_locked? && gps.present? && instance.present?
+      end
+
+      def exif
+        @exif ||= EXIFR::JPEG.new(file.path)
+      end
+    end
+  end
+end

data/lib/paperclip/location/railtie.rb

@@ -0,0 +1,14 @@
+require 'paperclip'
+require 'paperclip/location/processor'
+
+module Paperclip
+  module Location
+    class Railtie < Rails::Railtie
+      initializer "paperclip-location.configure_rails_initialization" do
+        Paperclip.configure do |c|
+          c.register_processor :location, Paperclip::Location::Processor.new
+        end
+      end
+    end
+  end
+end

data/lib/paperclip/paperclip.rb

@@ -0,0 +1 @@
+require 'paperclip/location'

data/paperclip-location.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-location"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Sean Doyle"]
+  spec.email         = ["sean.p.doyle24@gmail.com"]
+  spec.description   = %q{extract geolocation during Paperclip processing}
+  spec.summary       = %q{extract geolocation EXIF data during Paperclip processing}
+  spec.homepage      = "https://github.com/seanpdoyle/paperclip-location"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+
+  spec.add_dependency "paperclip", "~> 3.5"
+  spec.add_dependency "exifr", "~> 1.1"
+end

data/spec/paperclip/location/processor_spec.rb

@@ -0,0 +1,70 @@
+require_relative '../../spec_helper'
+
+def does_nothing(model)
+  %w(lat? lng?).each do |field|
+    expect(model).not_to receive(field)
+  end
+end
+
+describe Paperclip::Location::Processor do
+  subject { described_class.new nil }
+  it { should be_a Paperclip::Processor }
+end
+
+describe Paperclip::Location::Processor, '#make' do
+  let(:model) { double :model }
+  let(:attachment) { double :attachment, instance: model }
+  subject { described_class.new(file, {}, attachment) }
+
+  it "returns the original file, unmodified" do
+    file = File.new(Photos::WITHOUT_EXIF.path)
+    expect(described_class.new(file).make).to be file
+  end
+
+  context "when the model's location is locked" do
+    let(:file){ File.new(Photos::WITH_EXIF.path) }
+    
+    before do
+      expect(model).to receive(:location_locked?) { true }
+    end
+
+    after do
+      subject.make
+    end
+
+    it 'does not modify the Attachment model' do
+      does_nothing(model)
+    end
+  end
+
+  context "when the model's location is not locked" do
+    before do
+      expect(model).to receive(:location_locked?) { false }
+    end
+
+    context 'given a file with EXIF GPS data' do
+      let(:file){ File.new(Photos::WITH_EXIF.path) }
+
+      after do
+        subject.make
+      end
+
+      it "sets the `lat` and `lng` on the Attachment's model" do
+        expect(model).to receive(:lat=).with(Photos::WITH_EXIF.lat)
+        expect(model).to receive(:lng=).with(Photos::WITH_EXIF.lng)
+      end
+    end
+
+    context 'given a file without EXIF' do
+      let(:file){ File.new(Photos::WITHOUT_EXIF.path) }
+
+      after do
+        subject.make
+      end
+
+      it 'does not modify the Attachment model' do
+        does_nothing(model)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+
+Dir[File.join(File.dirname(File.realpath(__FILE__)), 'support/**/*.rb')].each { |file| require file }
+
+require 'paperclip/location'

data/spec/support/photos.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+
+module Photos
+  ROOT = File.join(File.dirname(File.realpath(__FILE__)), '../', 'photos')
+  WITH_EXIF = OpenStruct.new(
+    path: File.join(ROOT, 'with-exif.jpg'),
+    lat: 39.99783333333334,
+    lng: -75.2495
+  ).freeze
+
+  WITHOUT_EXIF = OpenStruct.new(
+    path: File.join(ROOT, 'without-exif.jpg'),
+    lat: nil,
+    lng: nil
+  ).freeze
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-location
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sean Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: exifr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: extract geolocation during Paperclip processing
+email:
+- sean.p.doyle24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paperclip/location.rb
+- lib/paperclip/location/processor.rb
+- lib/paperclip/location/railtie.rb
+- lib/paperclip/paperclip.rb
+- paperclip-location.gemspec
+- spec/paperclip/location/processor_spec.rb
+- spec/photos/with-exif.jpg
+- spec/photos/without-exif.jpg
+- spec/spec_helper.rb
+- spec/support/photos.rb
+homepage: https://github.com/seanpdoyle/paperclip-location
+licenses:
+- MIT
+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.2.0
+signing_key: 
+specification_version: 4
+summary: extract geolocation EXIF data during Paperclip processing
+test_files:
+- spec/paperclip/location/processor_spec.rb
+- spec/photos/with-exif.jpg
+- spec/photos/without-exif.jpg
+- spec/spec_helper.rb
+- spec/support/photos.rb