dimscan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8c3e5ac03d2656716393fde60824ab21e8b5346
+  data.tar.gz: 98a593adbda3cb4ae555644193a35eae499ef11d
+SHA512:
+  metadata.gz: aaffc8a3d90d43cf0d64868ca4eef3a22828fec7077968ecebb3c344094f934b8778e35e3d364fb1a796ac88a5fe0780f556c14f49cf85a4ff76e9deee36ef6a
+  data.tar.gz: ffbfa978cac9741363b3c26f6117038c802aee02344614f1f58f0cbcb40660a2dd61695c5cbcdeb762ac81eb96884f1df2ac91bbf7d5d5f91f661107002a7b4b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Joakim Reinert
+
+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,49 @@
+# Dimscan
+
+A small library for extracting pixel dimensions for images hosted on web
+servers. Only loads whatever portion is necessary to determine the dimensions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dimscan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dimscan
+
+## Usage
+
+``` ruby
+scanner = Dimscan::JPEGScanner.new('https://example.com/image.jpg')
+scanner.scan_dimensions
+# => { width: 32, height: 32 }
+```
+
+At the moment only JPEG and PNG are supported.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment. 
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dimscan/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dimscan"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dimscan.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dimscan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dimscan'
+  spec.version       = Dimscan::VERSION
+  spec.authors       = ['Joakim Reinert']
+  spec.email         = ['mail@jreinert.net']
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  end
+
+  spec.summary       = 'Scans dimensions from hosted images'
+  spec.description   = 'Bandwith efficient scanner for dimensions of web ' \
+                       'hosted images'
+  spec.homepage      = 'https://github.com/jreinert/dimscan'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'pry-byebug', '~> 3.0'
+
+  spec.add_dependency 'mini_magick', '~> 4.1'
+  spec.add_dependency 'abstractize', '~> 0.1'
+end

data/lib/dimscan/base_scanner.rb

@@ -0,0 +1,34 @@
+require 'uri'
+require 'dimscan/http_byte_enumerator'
+require 'mini_magick'
+require 'abstractize'
+
+module Dimscan
+  # The abstract base class
+  class BaseScanner
+    include Abstractize
+
+    def initialize(url)
+      @bytes = HTTPByteEnumerator.new(url)
+      @fallback_file = `mktemp`.chomp
+    end
+
+    def scan_dimensions
+      dimensions = nil
+      File.open(@fallback_file, 'wb') do |file|
+        dimensions = scan(@bytes.each) { |b| file.write(b) }
+      end
+      width, height = (
+        dimensions || MiniMagick::Image.new(@fallback_file).dimensions
+      )
+
+      { width: width, height: height }
+    end
+
+    protected
+
+    def scan(_bytes)
+      fail AbstractError, 'not implemented'
+    end
+  end
+end

data/lib/dimscan/http_byte_enumerator.rb

@@ -0,0 +1,39 @@
+require 'uri'
+require 'net/http'
+
+module Dimscan
+  # A utility class for enumerating over the bytes of a http response body
+  class HTTPByteEnumerator
+    def initialize(url)
+      @uri = URI(url)
+      fail ArgumentError, 'invalid scheme' unless @uri.scheme =~ /^https?$/
+    end
+
+    def each(&block)
+      return to_enum(__callee__) unless block_given?
+      request = Net::HTTP::Get.new(@uri)
+      Net::HTTP.start(
+        @uri.host, @uri.port, use_ssl: @uri.scheme == 'https'
+      ) do |http|
+        http.request(request) do |response|
+          fail response.body if error?(response)
+          enumerate_response(response, &block)
+        end
+      end
+    end
+
+    protected
+
+    def error?(response)
+      [Net::HTTPError, Net::HTTPClientError].any? do |error|
+        response.is_a?(error)
+      end
+    end
+
+    def enumerate_response(response, &block)
+      response.read_body do |chunk|
+        chunk.each_byte(&block)
+      end
+    end
+  end
+end

data/lib/dimscan/jpeg_scanner.rb

@@ -0,0 +1,30 @@
+require 'dimscan/base_scanner'
+
+module Dimscan
+  # Scans dimensions from a JPEG image
+  class JPEGScanner < BaseScanner
+    SOF0 = [0xFF, 0xC0, 0x00, 0x11, 0x08]
+
+    protected
+
+    def scan(bytes)
+      # Dimensions are in bytes 4-8 after SOF0
+      last_slice = nil
+      bytes.each_cons(SOF0.size + 4) do |slice|
+        yield slice.first.chr
+        last_slice = slice
+        if slice.first(SOF0.size) == SOF0
+          return extract_dimensions(slice.last(4))
+        end
+      end
+      yield last_slice[1..-1].map(&:chr).join
+      nil
+    end
+
+    def extract_dimensions(bytes)
+      # height is before width in jpeg header
+      byte_string = bytes.map(&:chr).join
+      byte_string.unpack('nn').reverse
+    end
+  end
+end

data/lib/dimscan/png_scanner.rb

@@ -0,0 +1,29 @@
+require 'dimscan/base_scanner'
+
+module Dimscan
+  # Scans dimensions from a PNG image
+  class PNGScanner < BaseScanner
+    IHDR = [0x49, 0x48, 0x44, 0x52]
+
+    protected
+
+    def scan(bytes)
+      # Dimensions are in 8 bytes after IHDR
+      last_slice = nil
+      bytes.each_cons(IHDR.size + 8) do |slice|
+        yield slice.first.chr
+        last_slice = slice
+        if slice.first(IHDR.size) == IHDR
+          return extract_dimensions(slice.last(8))
+        end
+      end
+      yield last_slice[1..-1].map(&:chr).join
+      nil
+    end
+
+    def extract_dimensions(bytes)
+      byte_string = bytes.map(&:chr).join
+      byte_string.unpack('NN')
+    end
+  end
+end

data/lib/dimscan/version.rb

@@ -0,0 +1,3 @@
+module Dimscan
+  VERSION = "0.1.0"
+end

data/lib/dimscan.rb

@@ -0,0 +1,4 @@
+require "dimscan/version"
+
+module Dimscan
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: dimscan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joakim Reinert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: abstractize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Bandwith efficient scanner for dimensions of web hosted images
+email:
+- mail@jreinert.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dimscan.gemspec
+- lib/dimscan.rb
+- lib/dimscan/base_scanner.rb
+- lib/dimscan/http_byte_enumerator.rb
+- lib/dimscan/jpeg_scanner.rb
+- lib/dimscan/png_scanner.rb
+- lib/dimscan/version.rb
+homepage: https://github.com/jreinert/dimscan
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Scans dimensions from hosted images
+test_files: []