fisherman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df9bf0fb1b8cf3b4671971b6a3e8e25f64d845ce
+  data.tar.gz: 0e160ccdbaa9e82773fc338f80c0d17a332caf16
+SHA512:
+  metadata.gz: 11cfc89593f018d57c3a989b0095d23aee4ffd7f60ef7cb94a9c71f5721d83c4bddae3644d689bf2edfd1259f12b0dba0e0b5d00e6a8daec1ee43f7f0fe43bb3
+  data.tar.gz: 6bceba0ac1aa3f0f0f2230a204e34aa07e494a92b0960f27329e13aa2edf37b2b26a320cd05122a0924016e0175a8ddc1d15ccae18bf59b2f5430a6e7f27f575

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 
+
+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,53 @@
+# Fisherman
+
+A library that wraps Snapfish's unpublished API used on their site. Currently,
+only a very few calls are supported, but there seems to be a lot more that
+could be implemented. I only needed enough coverage to get all the photo URLs,
+but pull requests are welcome for additional API support.
+
+API Usage:
+
+```ruby
+require 'fisherman'
+
+# Currently needs an active access token from the site. To get yours, log in,
+# open the developer tools and look for the `access_token` header on one of the
+# API requests.
+access_token = ...
+Snapfish.connect(access_token)
+
+# Get all albums -- returns an enumerable collection of Snapfish::Album objects
+albums = Snapfish::AlbumCollection.new.to_a
+
+# Print an album's name
+puts albums.first.name
+
+# Get all photos from an album
+photos = albums.first.assets
+
+# Print a photo's URL
+puts photos.first.hires_url
+```
+
+Included is a script called `extract_snapfish_albums` which returns information
+on all an account's albums, including URLs for downloading high-resolution
+photos. To use it:
+
+```bash
+> TOKEN=<access_token from site>
+> # Output a JSON file describing each ablum
+> extract_snapfish_albums $TOKEN > albums.json
+> # Output a bash script that downloads all album photos
+> BASH_SCRIPT=true extract_snapfish_albums $TOKEN > download.sh
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rustygeldmacher/fisherman.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fisherman"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/extract_snapfish_albums

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'fisherman'
+require 'shellwords'
+
+# TODO:
+# - Log in using email/password
+# - Use GetOpt for args
+
+token = ARGV[0]
+if token.nil?
+  puts "** Usage: snapfish_albums <TOKEN>"
+  exit 1
+end
+
+Snapfish.connect(token)
+
+STDERR.puts 'Gathering album information...'
+
+albums_json = Snapfish::AlbumCollection.new.map do |album|
+  photos_json = album.assets.map(&:as_json)
+  album.as_json.merge(photos: photos_json)
+end
+
+albums_json.sort_by! { |album| album[:created_at] }
+
+if ENV['BASH_SCRIPT']
+  puts <<-BASH
+#!/bin/bash
+#
+# Downloads all Snapfish albums and sorts them into folders by album title.
+# Folders are created in the current directory.
+# Requires `wget`.
+#
+  BASH
+
+  albums_json.each_with_index do |album_json, album_index|
+    directory_name = [
+      album_index.to_s.rjust(4, '0'),
+      Shellwords.escape(album_json[:name])
+    ].join(' - ')
+    puts "mkdir -p \"#{directory_name}\""
+    album_json[:photos].each_with_index do |photo_json, photo_index|
+      file_name = photo_index.to_s.rjust(4, '0') + '.' + photo_json[:file_extension]
+      destination_path = File.join(directory_name, file_name)
+      puts "wget \"#{photo_json[:url]}\" -O \"#{destination_path}\""
+    end
+  end
+else
+  puts JSON.pretty_generate(albums_json)
+end

data/fisherman.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fisherman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fisherman"
+  spec.version       = Fisherman::VERSION
+  spec.authors       = ["Rusty Geldmacher"]
+  spec.email         = ["russell.geldmacher@gmail.com"]
+
+  spec.summary       = %q{API wrapper for Snapfish}
+  spec.description   = %q{API wrapper for Snapfish's unpublished APIs}
+  spec.homepage      = "https://github.com/rustygeldmacher/fisherman"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "faraday", "~> 0.11.0"
+  spec.add_development_dependency "faraday_middleware", "~> 0.11.0"
+
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/fisherman.rb

@@ -0,0 +1,9 @@
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+
+require 'fisherman/version'
+require 'snapfish'
+
+module Fisherman
+end

data/lib/fisherman/version.rb

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

data/lib/snapfish.rb

@@ -0,0 +1,21 @@
+require 'snapfish/base'
+require 'snapfish/asset'
+require 'snapfish/album'
+require 'snapfish/album_collection'
+
+module Snapfish
+  API_BASE_URL = 'https://assets-aus.snapfish.com/pict/v2/collection'
+
+  def self.connect(token)
+    connection = Faraday.new(url: API_BASE_URL) do |conn|
+      conn.response :json
+      conn.adapter Faraday.default_adapter
+    end
+
+    connection.headers['Authorization'] = token
+    connection.headers['access_token'] = token
+    connection.headers['Accept'] = 'application/json'
+
+    Snapfish::Base.connection = connection
+  end
+end

data/lib/snapfish/album.rb

@@ -0,0 +1,42 @@
+module Snapfish
+  class Album < Base
+    def id
+      json['id']
+    end
+
+    def asset_count
+      json['assetIdList'].size
+    end
+
+    def name
+      extract_tag('userTags', 'caption')
+    end
+
+    def assets
+      album_json = connection.get(album_url,
+        assetType: 'ALL',
+        limit: 100,
+        skip: 0,
+        sortCriteria: 'dateTaken',
+        sortOrder: 'ascending'
+      ).body
+
+      album_json['entities'].map do |entity_json|
+        Asset.new(entity_json)
+      end
+    end
+
+    def as_json
+      {
+        name: name,
+        created_at: created_at
+      }
+    end
+
+    private
+
+    def album_url
+      "#{id}/assets"
+    end
+  end
+end

data/lib/snapfish/album_collection.rb

@@ -0,0 +1,26 @@
+module Snapfish
+  class AlbumCollection < Base
+    include Enumerable
+
+    def each
+      all.each { |album| yield album }
+    end
+
+    private
+
+    def all
+      albums_json = connection.get('monthIndex',
+        skip: 0,
+        limit: 100,
+        minCollection: 1000,
+        sortOrder: 'descending',
+        timezoneOffset: -300
+      ).body
+
+      albums_json['entityMap'].keys.flat_map do |entity|
+        collections = albums_json['entityMap'][entity]['collectionList']
+        collections.map { |collection_json| Album.new(collection_json) }
+      end
+    end
+  end
+end

data/lib/snapfish/asset.rb

@@ -0,0 +1,34 @@
+module Snapfish
+  class Asset < Base
+    def filename
+      os_metadata = extract_tag('systemTags', 'OS_METADATA')
+      if os_metadata && os_metadata = os_metadata['value']
+        os_metadata.match(/os.fn=(\S+)/)[1]
+      end
+    end
+
+    def caption
+      extract_tag('userTags', 'caption')
+    end
+
+    def file_extension
+      File.extname(hires_url).downcase.gsub(/^\./, '')
+    end
+
+    def hires_url
+      hires_file = json['files'].find { |f| f['fileType'] == 'HIRES' }
+      if hires_file
+        hires_file['url']
+      end
+    end
+
+    def as_json(options = {})
+      {
+        filename: filename,
+        file_extension: file_extension,
+        caption: caption,
+        url: hires_url
+      }
+    end
+  end
+end

data/lib/snapfish/base.rb

@@ -0,0 +1,45 @@
+module Snapfish
+  class Base
+    attr_reader :json
+
+    def initialize(json = {})
+      @json = json
+    end
+
+    def self.connection=(connection)
+      @@connection = connection
+    end
+
+    def self.connection
+      @@connection
+    end
+
+    def created_at
+      create_date = json['createDate']
+      if create_date
+        Time.at(create_date / 1000, create_date % 1000)
+      end
+    end
+
+     def updated_at
+       update_date = json['updateDate']
+       if update_date
+         Time.at(update_date / 1000, update_date % 1000)
+       end
+     end
+
+    private
+
+    def extract_tag(tag_group, tag_name)
+      tags = json[tag_group] || []
+      tag = tags.find { |t| t['key'] == tag_name }
+      if tag
+        tag['value']
+      end
+    end
+
+    def connection
+      Snapfish::Base.connection
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: fisherman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rusty Geldmacher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: API wrapper for Snapfish's unpublished APIs
+email:
+- russell.geldmacher@gmail.com
+executables:
+- extract_snapfish_albums
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/extract_snapfish_albums
+- fisherman.gemspec
+- lib/fisherman.rb
+- lib/fisherman/version.rb
+- lib/snapfish.rb
+- lib/snapfish/album.rb
+- lib/snapfish/album_collection.rb
+- lib/snapfish/asset.rb
+- lib/snapfish/base.rb
+homepage: https://github.com/rustygeldmacher/fisherman
+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.4.5
+signing_key: 
+specification_version: 4
+summary: API wrapper for Snapfish
+test_files: []