picasa-downloader 0.0.1

data/lib/picasa-downloader.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'require_all'
+require 'fileutils'
+require_all 'lib'
+require 'gdata'
+require 'nokogiri'
+require 'net/http'
+require 'uri'

data/lib/picasa-downloader/album.rb

@@ -0,0 +1,10 @@
+module PicasaDownloader
+  class Album
+    attr_reader :title, :id
+
+    def initialize(title, id)
+      @title = title
+      @id = id
+    end
+  end
+end

data/lib/picasa-downloader/album_persister.rb

@@ -0,0 +1,27 @@
+module PicasaDownloader
+  class AlbumPersister
+    def initialize(client, album, download_directory_root)
+      @client = client
+      @album = album
+      @download_directory_root = download_directory_root
+      FileUtils.mkdir_p(get_album_dir)
+    end
+
+    def download
+      @client.list_photos(@album.id).each { |photo|
+        photo_data = @client.download_photo(photo)
+        if photo_data
+          File.open(get_album_dir + photo.name, 'wb') { |file|
+            file.write(photo_data)
+          }
+        end
+      }
+    end
+
+    private
+
+    def get_album_dir
+      @download_directory_root + "/#{@album.title}/"
+    end
+  end
+end

data/lib/picasa-downloader/client.rb

@@ -0,0 +1,53 @@
+module PicasaDownloader
+  class Client
+    def initialize(credentials)
+      @gd = GData::Client::Photos.new
+      @gd.clientlogin(credentials.username, credentials.password)
+    end
+
+    def list_albums
+      doc = to_xml('https://picasaweb.google.com/data/feed/api/user/default')
+      doc.css('entry').map { |e|
+        id = e.xpath("id/text()").
+          select { |x| x.to_s.match(/^\d+$/) }.
+          map { |x| x.inner_text }.first
+        Album.new(e.css('title').first.inner_text, id)
+      }
+    end
+
+    def list_photos(album_id)
+      doc = to_xml(
+        "https://picasaweb.google.com/data/feed/api/user/default/albumid/#{album_id}?imgmax=d")
+      doc.css("entry").map { |e|
+        Photo.new(
+          e.xpath("group/content/@url").to_s,
+          # Google includes the milliseconds in the timestamp:
+          e.css("tags time").inner_text.to_i / 1000,
+          e.css("size").inner_text.to_i,
+          e.css("title").inner_text)
+      }
+    end
+
+    def download_photo(photo)
+      unless photo.url.include?"googlevideo"
+        uri = URI.parse(photo.url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        request = Net::HTTP::Get.new(uri.request_uri)
+        http.use_ssl = true
+        response = http.request(request)
+        raise "Response not ok, was #{response.code}" unless
+        response.code.to_i.between? 200, 299
+        response.body
+      end
+    end
+
+    private
+
+    def to_xml(gdata_url)
+      response = @gd.get(gdata_url)
+      xml = response.to_xml.to_s
+      doc = Nokogiri::XML(xml)
+      doc.remove_namespaces!
+    end
+  end
+end

data/lib/picasa-downloader/env_credentials.rb

@@ -0,0 +1,15 @@
+module PicasaDownloader
+  class EnvCredentials
+    attr_reader :username, :password
+
+    def initialize
+      @username = ENV['PICASA_USERNAME']
+      @password = ENV['PICASA_PASSWORD']
+    end
+
+    def is_configured?
+      ENV['PICASA_USERNAME'].to_s != '' &&
+      ENV['PICASA_PASSWORD'].to_s != ''
+    end
+  end
+end

data/lib/picasa-downloader/errors.rb

@@ -0,0 +1,10 @@
+module PicasaDownloader
+  class PicasaDownloaderError < StandardError
+  end
+
+  class EnvironmentalCredentialsNotSet < PicasaDownloaderError
+    def initialize(message = 'Cannot authenticate - environmental settings missing. Please set the environmental values PICASA_USERNAME and PICASA_PASSWORD')
+      super(message)
+    end
+  end
+end

data/lib/picasa-downloader/photo.rb

@@ -0,0 +1,12 @@
+module PicasaDownloader
+  class Photo
+    attr_reader :url, :created_date, :size, :name
+
+    def initialize(url, created_date_since_epoch, size, name)
+      @url = url
+      @created_date = Time.at(created_date_since_epoch)
+      @size = size
+      @name = name
+    end
+  end
+end

data/picasa-downloader.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name          = 'picasa-downloader'
+  s.version       = '0.0.1'
+  s.license       = 'MIT'
+  s.summary       = 'Download your Google Picasa photo albums'
+  s.description   =
+    'This Gem makes it convenient to download Picasa albums via command-line interface'
+  s.authors       = ['Lauri Lehmijoki']
+  s.email         = 'lauri.lehmijoki@iki.fi'
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.executables   << 'picasa-downloader'
+  s.homepage      = 'https://github.com/laurilehmijoki/picasa-downloader'
+
+  s.add_dependency 'require_all'
+  if RUBY_VERSION < "1.9"
+    s.add_dependency 'gdata'
+  else
+    s.add_dependency 'gdata_19'
+  end
+  s.add_dependency 'require_relative'
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'gli'
+  s.add_dependency 'rake'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+end

data/spec/album_persister_spec.rb

@@ -0,0 +1,38 @@
+require 'vcr'
+require 'test_helper'
+require_relative '../lib/picasa-downloader'
+
+module PicasaDownloader
+  describe AlbumPersister do
+    before :each do
+      VCR.use_cassette("google-login") do
+        @client = Client.new(EnvCredentials.new)
+        tempdir = ENV['TMPDIR']
+        tempdir = '' unless tempdir
+        @dir = tempdir + 'picasa-downloader-test'
+      end
+    end
+
+    after :each do
+      FileUtils.rm_r(@dir)
+    end
+
+    it "creates a directory for each album" do
+      with_cassettes {
+        @albums = @client.list_albums
+        AlbumPersister.new(@client, @albums.first, @dir).download
+        File.exists?(@dir + "/#{@albums.first.title}")
+      }
+    end
+
+    it "saves each photo into the album" do
+      with_cassettes {
+        @albums = @client.list_albums
+        AlbumPersister.new(@client, @albums.first, @dir).download
+        Dir.entries(@dir + "/#{@albums.first.title}/").any? { |file|
+          file.downcase.match(/jp(e)?g/)
+        }.should be true
+      }
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,50 @@
+require 'vcr'
+require_relative 'test_helper'
+require_relative '../lib/picasa-downloader'
+
+module PicasaDownloader
+  describe Client do
+    before :each do
+      VCR.use_cassette("google-login") do
+        @client = Client.new(EnvCredentials.new())
+      end
+    end
+
+    it "loads the album ids" do
+      VCR.use_cassette("picasa-albums") do
+        albums = @client.list_albums
+        albums.length.should be > 0
+        albums.first.id =~ /^\d+$/
+        albums.first.title.length.should be > 0
+      end
+    end
+
+    it "lists photos for an album" do
+      VCR.use_cassette("picasa-albums") do
+        @albums = @client.list_albums
+      end
+      VCR.use_cassette("picasa-album") do
+        photos = @client.list_photos(@albums.first.id)
+        photos.length.should be > 0
+        photos.first.url =~ /^https/
+        photos.first.created_date.should be < Time.new
+        photos.first.created_date.should be > Time.at(0)
+        photos.first.size.should be > 0
+        photos.first.name.length.should be > 0
+      end
+    end
+
+    it "downloads photos photos of an album" do
+      with_cassettes {
+        @albums = @client.list_albums
+        @photos = @client.list_photos(@albums.first.id)
+        def jpeg?(data)
+          # See http://www.astro.keele.ac.uk/oldusers/rno/Computing/File_magic.html
+          return data[0, 4] == "\xff\xd8\xff\xe0"
+        end
+        bytes = @client.download_photo(@photos.first)
+        jpeg?(bytes).should be true
+      }
+    end
+  end
+end

data/spec/env_credentials_spec.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+require_relative '../lib/picasa-downloader'
+
+module PicasaDownloader
+  describe EnvCredentials do
+    it "knows when the credentials are not set" do
+      ENV['PICASA_USERNAME'] = ''
+      ENV['PICASA_PASSWORD'] = ''
+      creds = EnvCredentials.new
+      creds.is_configured?.should be false
+    end
+
+    it "knows when the credentials are set" do
+      ENV['PICASA_USERNAME'] = 'uzer'
+      ENV['PICASA_PASSWORD'] = 'pazz'
+      creds = EnvCredentials.new
+      creds.is_configured?.should be true
+    end
+  end
+end

data/spec/test_helper.rb

@@ -0,0 +1,23 @@
+require 'require_relative'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "fixtures/cassettes"
+  config.hook_into :webmock
+end
+
+def with_cassettes
+  photo_matcher = lambda do |req_1, req_2|
+    [req_1, req_2].all? { |req|
+      req.uri.include?"googleusercontent"
+    }
+  end
+  VCR.use_cassette("picasa-albums") do
+    VCR.use_cassette("picasa-album") do
+      VCR.use_cassette("picasa-photo",
+                       :match_requests_on => [photo_matcher],
+                       :allow_playback_repeats => true) do
+        yield
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification 
+name: picasa-downloader
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lauri Lehmijoki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: gdata
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: require_relative
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: gli
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: This Gem makes it convenient to download Picasa albums via command-line interface
+email: lauri.lehmijoki@iki.fi
+executables: 
+- picasa-downloader
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- Rakefile
+- TODO.md
+- bin/picasa-downloader
+- fixtures/cassettes/google-login.yml
+- fixtures/cassettes/picasa-album.yml
+- fixtures/cassettes/picasa-albums.yml
+- fixtures/cassettes/picasa-photo.yml
+- lib/picasa-downloader.rb
+- lib/picasa-downloader/album.rb
+- lib/picasa-downloader/album_persister.rb
+- lib/picasa-downloader/client.rb
+- lib/picasa-downloader/env_credentials.rb
+- lib/picasa-downloader/errors.rb
+- lib/picasa-downloader/photo.rb
+- picasa-downloader.gemspec
+- spec/album_persister_spec.rb
+- spec/client_spec.rb
+- spec/env_credentials_spec.rb
+- spec/test_helper.rb
+homepage: https://github.com/laurilehmijoki/picasa-downloader
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.13
+signing_key: 
+specification_version: 3
+summary: Download your Google Picasa photo albums
+test_files: []
+