fisherman 0.1.0 → 0.3.0

checksums.yaml

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

data/README.md

@@ -36,11 +36,16 @@ photos. To use it:
 ```bash
 > TOKEN=<access_token from site>
 > # Output a JSON file describing each ablum
-> extract_snapfish_albums $TOKEN > albums.json
+> extract_snapfish_albums --token $TOKEN --output json > albums.json
 > # Output a bash script that downloads all album photos
-> BASH_SCRIPT=true extract_snapfish_albums $TOKEN > download.sh
+> extract_snapfish_albums --token $TOKEN --output bash > download.sh
 ```
 
+The generated Bash script will in turn use the `download_snapfish_album` script.
+This script takes a token and an album ID and downloads all of the album's 
+photos to a directory underneath the current one. The album directory is named
+with the date of the album and first, then the title of the album.
+
 ## 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.

data/exe/download_snapfish_album

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require 'fisherman'
+require 'fileutils'
+require 'getoptlong'
+
+at_exit do
+  last_exception = $!
+  if last_exception.is_a?(Faraday::ClientError)
+    if last_exception.response && last_exception.response[:status] == 401
+      puts "** Snapfish authentication failed."
+      puts "** Please make sure your token is valid and try again"
+      exit! 1
+    end
+    exit 1
+  end
+end
+
+opts = GetoptLong.new(
+  ['--token', '-t', GetoptLong::REQUIRED_ARGUMENT],
+  ['--album-id', '-a', GetoptLong::REQUIRED_ARGUMENT]
+)
+
+opts.each do |op, value|
+  case op
+  when '--token'
+    @token = value
+  when '--album-id'
+    @album_id = value
+  end
+end
+
+if !@token || !@album_id
+  puts <<-HELP
+** Usage: #{$0} --token <token> --album-id <album-id>
+**
+** Will download the contents of the album into a directory relative
+** to the current directory, and named with the album date plus the
+** album name.
+  HELP
+  exit 1
+end
+
+def mark_as_thumbnail(file_path, asset)
+  file_path.gsub(/(\.#{asset.file_extension})$/) { |ext| "_#{ext}" }
+end
+
+def download_photo(photo, destination_file)
+  downloader = Fisherman::Downloader.new(photo)
+  if file_contents = downloader.download
+    if downloader.thumbnail?
+      destination_file = mark_as_thumbnail(destination_file, photo)
+    end
+    File.open(destination_file, 'wb') { |f| f.write(file_contents) }
+    puts "Wrote #{destination_file} (#{file_contents.size} bytes)"
+  else
+    puts "Could not download photo #{photo.id}"
+  end
+end
+
+Snapfish.connect(@token)
+
+puts "Gathering information about album #{@album_id}"
+
+album = Snapfish::Album.get(@album_id)
+if album.nil?
+  puts "** Could not find album with ID #{@album_id}"
+  exit 1
+end
+
+album_directory =  "#{album.created_at.strftime('%Y-%m-%d')} - #{album.name}"
+FileUtils.mkdir_p(album_directory)
+
+puts "Downloading album to directory \"#{album_directory}\""
+
+album.assets.each_with_index do |photo, index|
+  file_name = index.to_s.rjust(4, '0') + '.' + photo.file_extension
+  destination_file = File.join(album_directory, file_name)
+  download_photo(photo, destination_file)
+end

data/exe/extract_snapfish_albums

@@ -1,51 +1,74 @@
 #!/usr/bin/env ruby
 
 require 'fisherman'
-require 'shellwords'
+require 'getoptlong'
 
-# TODO:
-# - Log in using email/password
-# - Use GetOpt for args
+at_exit do
+  last_exception = $!
+  if last_exception.is_a?(Faraday::ClientError)
+    if last_exception.response && last_exception.response[:status] == 401
+      puts "** Snapfish authentication failed."
+      puts "** Please make sure your token is valid and try again"
+      exit! 1
+    end
+  end
+end
+
+opts = GetoptLong.new(
+  ['--token', '-t', GetoptLong::REQUIRED_ARGUMENT],
+  ['--output', '-o', GetoptLong::REQUIRED_ARGUMENT]
+)
+
+@output = :json
+
+opts.each do |op, value|
+  case op
+  when '--token'
+    @token = value
+  when '--output'
+    if value.to_sym == :bash
+      @output = :bash
+    end
+  end
+end
 
-token = ARGV[0]
-if token.nil?
-  puts "** Usage: snapfish_albums <TOKEN>"
+if !@token
+  puts <<-HELP
+** Usage: #{$0} --token <token> --output <json|bash>
+**
+** Will find all album data for the account with the current token.
+** Output is either a JSON object representing all album and photo
+** information (the default), or a bash script that makes calls to
+** download each album.
+  HELP
   exit 1
 end
 
-Snapfish.connect(token)
+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 = Snapfish::AlbumCollection.new.map(&:as_json)
 albums_json.sort_by! { |album| album[:created_at] }
 
-if ENV['BASH_SCRIPT']
+if @output == :bash
   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`.
+# Downloads Snapfish albums and sorts them into folders by album title.
 #
+TOKEN='#{@token}'
+
+set -e
+
   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
+  albums_json.each do |album_json|
+    album_id = album_json[:id]
+    puts "# #{album_json[:name]}"
+    puts "download_snapfish_album --token $TOKEN --album-id #{album_id}"
+    puts
   end
 else
-  puts JSON.pretty_generate(albums_json)
+  puts JSON.pretty_generate(albums: albums_json)
 end

data/fisherman.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "faraday", "~> 0.11.0"
+  spec.add_dependency "faraday_middleware", "~> 0.11.0"
+
   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

@@ -3,6 +3,7 @@ require 'faraday'
 require 'faraday_middleware'
 
 require 'fisherman/version'
+require 'fisherman/downloader'
 require 'snapfish'
 
 module Fisherman

data/lib/fisherman/downloader.rb

@@ -0,0 +1,54 @@
+module Fisherman
+  class Downloader
+    THUMBNAIL_API_URL = 'https://tnl.snapfish.com/assetrenderer/v2/thumbnail/'
+
+    attr_reader :asset
+
+    def initialize(asset)
+      @asset = asset
+      @thumbnail = false
+    end
+
+    def thumbnail?
+      @thumbnail
+    end
+
+    def download
+      response = Faraday.get(asset.hires_url)
+      # The Snapfish main CDN sometimes doesn't have older photos. In that case,
+      # the only way to get them is via their thumbnail API. We ask for the
+      # largest thumbnail we can get. If you were to download this same asset from
+      # the site, the large thumbnail is what it would return.
+      if response.status == 404
+        @thumbnail = true
+        response = download_thumbnail(asset)
+      end
+      response && response.body
+    end
+
+    private
+
+    def download_thumbnail(asset)
+      retries_remaining = 3
+      begin
+        thumbnail_url = File.join(THUMBNAIL_API_URL, asset.snapfish_ref)
+        response = Faraday.get(thumbnail_url,
+          height: asset.height,
+          access_token: Snapfish.token
+        )
+        if response.status == 302
+          response = Faraday.get(response.headers['location'])
+        end
+      rescue Faraday::ResourceNotFound
+        response = nil
+      rescue Faraday::ConnectionFailed => e
+        retries_remaining -= 1
+        if retries_remaining == 0
+          raise e
+        else
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/fisherman/version.rb

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

data/lib/snapfish.rb

@@ -4,11 +4,13 @@ require 'snapfish/album'
 require 'snapfish/album_collection'
 
 module Snapfish
-  API_BASE_URL = 'https://assets-aus.snapfish.com/pict/v2/collection'
+  API_BASE_URL = 'https://assets-aus.snapfish.com/pict/v2/'
 
   def self.connect(token)
     connection = Faraday.new(url: API_BASE_URL) do |conn|
+      conn.request :json
       conn.response :json
+      conn.response :raise_error
       conn.adapter Faraday.default_adapter
     end
 
@@ -18,4 +20,8 @@ module Snapfish
 
     Snapfish::Base.connection = connection
   end
+
+  def self.token
+    Snapfish::Base.connection.headers['access_token']
+  end
 end

data/lib/snapfish/album.rb

@@ -1,5 +1,12 @@
 module Snapfish
   class Album < Base
+    def self.get(album_id)
+      response = connection.get("collection/#{album_id}")
+      if response.success?
+        Snapfish::Album.new(response.body['entities'].first)
+      end
+    end
+
     def id
       json['id']
     end
@@ -15,7 +22,7 @@ module Snapfish
     def assets
       album_json = connection.get(album_url,
         assetType: 'ALL',
-        limit: 100,
+        limit: asset_count,
         skip: 0,
         sortCriteria: 'dateTaken',
         sortOrder: 'ascending'
@@ -28,6 +35,7 @@ module Snapfish
 
     def as_json
       {
+        id: id,
         name: name,
         created_at: created_at
       }
@@ -36,7 +44,7 @@ module Snapfish
     private
 
     def album_url
-      "#{id}/assets"
+      "collection/#{id}/assets"
     end
   end
 end

data/lib/snapfish/album_collection.rb

@@ -9,7 +9,7 @@ module Snapfish
     private
 
     def all
-      albums_json = connection.get('monthIndex',
+      albums_json = connection.get('collection/monthIndex',
         skip: 0,
         limit: 100,
         minCollection: 1000,

data/lib/snapfish/asset.rb

@@ -1,5 +1,13 @@
 module Snapfish
   class Asset < Base
+    def id
+      json['_id']
+    end
+
+    def snapfish_ref
+      find_file('THUMBNAIL')['url']
+    end
+
     def filename
       os_metadata = extract_tag('systemTags', 'OS_METADATA')
       if os_metadata && os_metadata = os_metadata['value']
@@ -7,6 +15,18 @@ module Snapfish
       end
     end
 
+    def size
+      json['files'].first['size']
+    end
+
+    def width
+      find_file('HIRES')['width']
+    end
+
+    def height
+      find_file('HIRES')['height']
+    end
+
     def caption
       extract_tag('userTags', 'caption')
     end
@@ -16,19 +36,27 @@ module Snapfish
     end
 
     def hires_url
-      hires_file = json['files'].find { |f| f['fileType'] == 'HIRES' }
-      if hires_file
-        hires_file['url']
-      end
+      find_file('HIRES')['url']
     end
 
     def as_json(options = {})
       {
+        id: id,
+        ref: snapfish_ref,
         filename: filename,
         file_extension: file_extension,
+        width: width,
+        height: height,
+        size: size,
         caption: caption,
         url: hires_url
       }
     end
+
+    private
+
+    def find_file(type)
+      json['files'].find { |f| f['fileType'] == type} || {}
+    end
   end
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: fisherman
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rusty Geldmacher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
+        version: 0.11.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: 0.11.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ description: API wrapper for Snapfish's unpublished APIs
 email:
 - russell.geldmacher@gmail.com
 executables:
+- download_snapfish_album
 - extract_snapfish_albums
 extensions: []
 extra_rdoc_files: []
@@ -95,9 +96,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/download_snapfish_album
 - exe/extract_snapfish_albums
 - fisherman.gemspec
 - lib/fisherman.rb
+- lib/fisherman/downloader.rb
 - lib/fisherman/version.rb
 - lib/snapfish.rb
 - lib/snapfish/album.rb