gallery-remote 0.0.1

data/LICENSE.md

@@ -0,0 +1 @@
+[License](http://mwalker.info/license.html)

data/README

@@ -0,0 +1,3 @@
+I'm expanding the gallery-remote code for use in another project.  I don't
+intend to make it feature-complete or package it well, just make it serviceable
+for my other work.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+ 
+$:.unshift File.join(File.dirname(__FILE__), '/lib')
+require 'gallery'
+ 
+PKG_NAME = 'gallery-remote'
+PKG_VERSION = Gallery::VERSION
+ 
+LIB_FILES = Dir.glob('lib/**/*')
+RELEASE_FILES = [ 'Rakefile', 'README', 'LICENSE.md' ] + LIB_FILES
+ 
+task :default => [ :package ]
+ 
+spec = Gem::Specification.new do |spec|
+  spec.name = PKG_NAME
+  spec.version = PKG_VERSION
+  spec.summary = 'A Ruby client for the Gallery2 photo gallery system'
+  spec.description = 'gallery-remote is an implementation of the Gallery Remote protocol in Ruby.'
+  spec.authors = ['Carl Leiby', 'Matt Walker']
+  spec.email = 'matt.r.walker@gmail.com'
+  spec.homepage = 'http://github.com/mrwalker/gallery-remote'
+  spec.files = RELEASE_FILES
+  spec.rubyforge_project = PKG_NAME
+end
+ 
+Rake::GemPackageTask.new(spec) do |package|
+  package.need_tar = true
+end

data/lib/cookie_jar.rb

@@ -0,0 +1,59 @@
+# 
+# cookie_jar.rb
+# 
+# Created on Sep 19, 2007, 7:39:33 PM
+require 'date'
+
+class CookieJar
+  def initialize
+    @cookies = []
+  end
+  
+  def add(cookie_list)
+    return if ! cookie_list
+    cookie_list.each do |cookie_string|
+      cookie = Cookie.new(cookie_string)
+      if ! cookie.expired
+        @cookies = @cookies.reject {|c| c.name==cookie.name}
+        @cookies << cookie
+      end
+    end
+  end
+  
+  def cookies
+    return if @cookies.length == 0
+    @cookies.map { |cookie| cookie.to_s }.join("; ")
+  end
+end
+
+class Cookie
+  attr_accessor :name, :value, :expiration
+  
+  def initialize(cookie_str)
+    cookie_str.split(/;\s?/).each_with_index do |c,i|
+      if i==0
+        @name, *values = c.split("=")
+        @value = values.join("=")
+      else
+        attr_name, *attr_values = c.split("=")
+        attr_value = attr_values.join("=")
+        if attr_name =~ /expires/i
+          @expiration = attr_value
+        end
+      end
+    end
+  end
+  
+  def to_s
+    "#{@name}=#{@value}"
+  end
+  
+  def expired
+    if @expiration
+      @expiration.sub!(/^([a-zA-Z]+,)(\d)/) { |s| "#{$1} #{$2}" }
+      expiration_date = DateTime.parse( @expiration, true )
+      return expiration_date < DateTime.now    
+    end
+    false
+  end
+end

data/lib/gallery.rb

@@ -0,0 +1,8 @@
+require 'gallery/remote'
+require 'gallery/gallery'
+require 'gallery/album'
+require 'gallery/image'
+
+module Gallery
+  VERSION = '0.0.1'
+end

data/lib/gallery/album.rb

@@ -0,0 +1,64 @@
+module Gallery
+  class Album
+    attr_accessor :remote, :params
+
+    def initialize(remote, params)
+      @remote, @params = remote, params
+    end
+
+    def properties(params = {})
+      @remote.album_properties(name, params)
+    end
+
+    def images(params = {})
+      response = @remote.fetch_album_images(name, params)
+      image_params = response.keys.inject([]) do |image_params, key|
+        next image_params unless key =~ /image\.(.*)\.(\d+)/
+        _, param, index = key.match(/image\.(.*)\.(\d+)/).to_a
+        index = index.to_i
+        image_params[index] ||= {}
+        image_params[index][param] = response[key]
+        image_params
+      end.compact # Keys are 1-based; remove first element
+      image_params.map do |params|
+        image = Image.new(@remote, params)
+        yield image if block_given?
+        image
+      end
+    end
+
+    def add_item(file_name, params = {})
+      @remote.add_item(name, file_name, params)
+    end
+
+    def add_album(title, params = {})
+      @remote.new_album(name, { :newAlbumName => title_to_name(title), :newAlbumTitle => title }.merge(params))
+    end
+    
+    def name
+      @params['name']
+    end
+    
+    def title
+      @params['title']
+    end
+    
+    def parent
+      @params['parent']
+    end
+    
+    def to_s
+      "Album #{name}: #{title}"
+    end
+
+    private
+
+    def title_to_name(title)
+      name = title.dup
+      name.downcase!
+      name.gsub!(/[,'\-:]/, '') # Remove illegal characters
+      name.gsub!(/\s+/, '_')    # Join words with underscores
+      name
+    end
+  end
+end

data/lib/gallery/gallery.rb

@@ -0,0 +1,31 @@
+module Gallery
+  class Gallery
+    attr_accessor :remote
+
+    def initialize(url, &block)
+      @remote = Remote.new(url)
+      instance_eval(&block) if block_given?
+    end
+
+    def login(user, pass)
+      @remote.login(user, pass)
+    end
+
+    def albums(params = {})
+      response = @remote.fetch_albums_prune
+      album_params = response.keys.inject([]) do |album_params, key|
+        next album_params unless key =~ /album\.(.*)\.(\d+)/
+        _, param, index = key.match(/album\.(.*)\.(\d+)/).to_a
+        index = index.to_i
+        album_params[index] ||= {}
+        album_params[index][param] = response[key]
+        album_params
+      end.compact # Keys are 1-based; remove first element
+      album_params.map do |params|
+        album = Album.new(@remote, params)
+        yield album if block_given?
+        album
+      end
+    end
+  end
+end

data/lib/gallery/image.rb

@@ -0,0 +1,29 @@
+module Gallery
+  class Image
+    attr_accessor :remote, :params
+
+    def initialize(remote, params = {})
+      @remote, @params = remote, params
+    end
+
+    def properties(params = {})
+      @remote.image_properites(name, params)
+    end
+
+    def name
+      @params['name']
+    end
+
+    def title
+      @params['title']
+    end
+
+    def caption
+      @params['caption']
+    end
+
+    def to_s
+      "Image #{name}: #{title}"
+    end
+  end
+end

data/lib/gallery/remote.rb

@@ -0,0 +1,233 @@
+require 'cgi'
+require 'net/http'
+require 'cookie_jar'
+
+module Gallery
+  class Remote
+    attr_accessor :last_response, :status, :status_text
+
+    GR_STAT_SUCCESS = 0
+    PROTO_MAJ_VER_INVAL = 101
+    PROTO_MIN_VER_INVAL = 102
+    PROTO_VER_FMT_INVAL = 103
+    PROTO_VER_MISSING = 104
+    PASSWD_WRONG = 201
+    LOGIN_MISSING = 202
+    UNKNOWN_CMD = 301
+    NO_ADD_PERMISSION = 401
+    NO_FILENAME = 402
+    UPLOAD_PHOTO_FAIL = 403
+    NO_WRITE_PERMISSION = 404
+    NO_VIEW_PERMISSIO = 405
+    NO_CREATE_ALBUM_PERMISSION = 501
+    CREATE_ALBUM_FAILED = 502
+    MOVE_ALBUM_FAILED = 503
+    ROTATE_IMAGE_FAILED = 504
+    STATUS_DESCRIPTIONS = { 
+      GR_STAT_SUCCESS => 'The command the client sent in the request completed successfully. The data (if any) in the response should be considered valid.',
+      PROTO_MAJ_VER_INVAL => 'The protocol major version the client is using is not supported.',
+      PROTO_MIN_VER_INVAL => 'The protocol minor version the client is using is not supported.',
+      PROTO_VER_FMT_INVAL => 'The format of the protocol version string the client sent in the request is invalid.',
+      PROTO_VER_MISSING => 'The request did not contain the required protocol_version key.',
+      PASSWD_WRONG => 'The password and/or username the client send in the request is invalid.',
+      LOGIN_MISSING => 'The client used the login command in the request but failed to include either the username or password (or both) in the request.',
+      UNKNOWN_CMD => 'The value of the cmd key is not valid.',
+      NO_ADD_PERMISSION => 'The user does not have permission to add an item to the gallery.',
+      NO_FILENAME => 'No filename was specified.',
+      UPLOAD_PHOTO_FAIL => 'The file was received, but could not be processed or added to the album.',
+      NO_WRITE_PERMISSION => 'No write permission to destination album.',
+      NO_VIEW_PERMISSIO => 'No view permission for this image.',
+      NO_CREATE_ALBUM_PERMISSION => 'A new album could not be created because the user does not have permission to do so.',
+      CREATE_ALBUM_FAILED => 'A new album could not be created, for a different reason (name conflict).',
+      MOVE_ALBUM_FAILED => 'The album could not be moved.',
+      ROTATE_IMAGE_FAILED => 'The image could not be rotated' 
+    }          
+
+    @@supported_types = {
+      '.avi'  => 'video/x-msvideo',
+      '.bmp'  => 'image/bmp',
+      '.gif'  => 'image/gif',
+      '.jpe'  => 'image/jpeg',
+      '.jpg'  => 'image/jpeg',
+      '.jpeg' => 'image/jpeg',
+      '.mov'  => 'video/quicktime',
+      '.qt'   => 'video/quicktime',
+      '.mp4'  => 'video/mp4',
+      '.tif'  => 'image/tiff',
+      '.tiff' => 'image/tiff'
+    }
+
+    def self.supported_type?(extension)
+      @@supported_types.has_key?(extension)
+    end
+
+    def initialize(url)
+      @uri = URI.parse(url)
+      @base_params = {
+        'g2_controller' => 'remote:GalleryRemote',
+        'g2_form[protocol_version]' => '2.9'
+      }
+      @cookie_jar = CookieJar.new    
+      @boundary = '7d21f123d00c4'
+    end
+
+    # cmd=login
+    # protocol_version=2.0
+    # uname=gallery-user-name
+    # password=cleartext-password
+    def login(uname, password, params = {})
+      params = { :cmd => 'login', :uname => uname, :password => password }.merge(params)
+      send_request(params)
+    end
+
+    # cmd=fetch-albums-prune
+    # protocol_version=2.2
+    # no_perms=yes/no [optional, G2 since 2.9]
+    def fetch_albums_prune(params = {})
+      params = { :cmd => 'fetch-albums-prune', :no_perms => 'y' }.merge(params)
+      send_request(params)
+    end
+
+    # cmd=add-item
+    # protocol_version=2.0
+    # set_albumName=album name
+    # userfile=user-file
+    # userfile_name=file-name
+    # caption=caption [optional]
+    # force_filename=force-filename [optional]
+    # auto_rotate=yes/no [optional, since 2.5]
+    # extrafield.fieldname=fieldvalue [optional, since 2.3]
+    def add_item(set_albumName, userfile_name, params = {})
+      params = { :cmd => 'add-item', :set_albumName => set_albumName, :userfile_name => userfile_name }.merge(params)
+      send_request(params)
+    end
+
+    # cmd=album-properties
+    # protocol_version=2.0
+    # set_albumName=album-name
+    def album_properties(set_albumName, params = {})
+      params = { :cmd => 'album-properties', :set_albumName => set_albumName }.merge(params)
+      send_request(params)
+    end
+
+    # cmd=new-album
+    # protocol_version=2.1
+    # set_albumName=parent-album-name
+    # newAlbumName=album-name [optional]
+    # newAlbumTitle=album-title [optional]
+    # newAlbumDesc=album-description [optional]
+    def new_album(set_albumName, params = {})
+      params = { :cmd => 'new-album', :set_albumName => set_albumName }.merge(params)
+      send_request(params)
+    end
+
+    # cmd=fetch-album-images
+    # protocol_version=2.4
+    # set_albumName=album-name
+    # albums_too=yes/no [optional, since 2.13]
+    # random=yes/no [optional, G2 since ***]
+    # limit=number-of-images [optional, G2 since ***]
+    # extrafields=yes/no [optional, G2 since 2.12]
+    # all_sizes=yes/no [optional, G2 since 2.14]
+    def fetch_album_images(set_albumName, params = {})
+      params = { :cmd => 'fetch-album-images', :set_albumName => set_albumName }.merge(params)
+      send_request(params)
+    end
+
+    # cmd=image-properties
+    # protocol_version=***
+    # id=item-id
+    def image_properties(id, params = {})
+      params = { :cmd => 'image-properties', :id => id }.merge(params)
+      send_request(params)
+    end
+
+    def status_msg
+      "#{@status} - (#{@status_text})"
+    end
+
+    private
+
+    def build_multipart_query(params, userfile_name)
+      params['g2_userfile_name'] = userfile_name
+      request = params.map{ |k, v| "Content-Disposition: form-data; name=\"#{k}\"\r\n\r\n#{v}\r\n" }
+      content = File.open(userfile_name, 'r'){ |f| f.read }
+      request << "Content-Disposition: form-data; name=\"g2_userfile\"; filename=\"#{userfile_name}\"\r\n" +
+        "Content-Transfer-Encoding: binary\r\n" +
+        "Content-Type: #{@@supported_types[File.extname(userfile_name).downcase]}\r\n\r\n" +
+        content + "\r\n"
+      request.collect { |p| "--#{@boundary}\r\n#{p}" }.join("") + "--#{@boundary}--"
+    end
+
+    def build_query(params)
+      params.map{ |k, v| "#{k}=#{v}" }.join('&')
+    end
+
+    def send_request(params)
+      userfile_name = params.delete(:userfile_name)
+      post_parameters = prep_params(params)
+      headers = {}    
+      headers['Cookie'] = @cookie_jar.cookies if @cookie_jar.cookies
+      if userfile_name && File.file?(userfile_name)
+        query = build_multipart_query(post_parameters, userfile_name)
+        headers['Content-type'] = "multipart/form-data, boundary=#{@boundary}" if @boundary
+      else
+        query = build_query(post_parameters)
+      end
+      res = post(query, headers)
+      case res
+      when Net::HTTPSuccess, Net::HTTPRedirection
+        handle_response(res)
+      else
+        res.error!
+      end
+    end
+
+    def post(query, headers = {}, retries = 3)
+      begin
+        Net::HTTP.start(@uri.host, @uri.port) do |h|
+          h.post(@uri.path, query, headers)
+        end
+      rescue Exception => e
+        puts "Error during POST (#{retries} retries remain): #{e}"
+        throw e if retries == 0
+        post(query, headers, retries - 1)
+      end
+    end
+
+    def prep_params(params)
+      result = {}
+      result = result.merge(@base_params)
+      params.each_pair do |name, value|
+        result["g2_form[#{name}]"] = value
+      end
+      result['g2_authToken'] = @auth_token if @auth_token
+      result
+    end
+
+    def handle_response(res)
+      @cookie_jar.add(res.header.get_fields('set-cookie'))
+      @last_response = {}
+      begin
+        header = false
+        res.body.each do |line|
+          header = true if line.chomp == '#__GR2PROTO__'
+          next unless header   # Ignore debug output
+          next if line =~ /^#/ # Ignore comments
+          name, *values = line.strip.split(/\s*=\s*/)
+          @last_response[name.strip] = values.join('=')
+        end
+      rescue Exception => e
+        puts "Error parsing response:\n#{res.body}"
+        throw e
+      end
+      @auth_token ||= @last_response['auth_token']
+      puts 'WARN: no auth token in response (using last)' unless @last_response['auth_token']
+      @status = @last_response['status'].to_i
+      @status_text = @last_response['status_text']
+      puts status_msg
+      puts "WARN: #{STATUS_DESCRIPTIONS[@status]}" unless @status == GR_STAT_SUCCESS
+      @last_response
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: gallery-remote
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Carl Leiby
+- Matt Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: gallery-remote is an implementation of the Gallery Remote protocol in Ruby.
+email: matt.r.walker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README
+- LICENSE.md
+- lib/cookie_jar.rb
+- lib/gallery/album.rb
+- lib/gallery/gallery.rb
+- lib/gallery/image.rb
+- lib/gallery/remote.rb
+- lib/gallery.rb
+has_rdoc: true
+homepage: http://github.com/mrwalker/gallery-remote
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gallery-remote
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby client for the Gallery2 photo gallery system
+test_files: []
+