ZenfolioAPI 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Slone
+
+MIT License
+
+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,29 @@
+# ZenfolioAPI
+
+This is a basic implementation of the Zenfolio API. More features like uploading photos will come later.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ZenfolioAPI'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ZenfolioAPI
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "net/http"
+require "uri"
+require "json"

data/ZenfolioAPI.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ZenfolioAPI/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Slone"]
+  gem.email         = ["dbslone@gmail.com"]
+  gem.description   = %q{Basic implementation of the Zenfolio API.}
+  gem.summary       = %q{Currently just a basic implementation of the Zenfolio API with features to list all galleries and photos, and get all the information about a gallery or photo.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ZenfolioAPI"
+  gem.require_paths = ["lib"]
+  gem.version       = ZenfolioAPI::VERSION
+
+  gem.add_development_dependency "rspec", "~> 2.6"
+end

data/lib/ZenfolioAPI.rb

@@ -0,0 +1,28 @@
+require "ZenfolioAPI/version"
+require "ZenfolioAPI/authentication"
+require "ZenfolioAPI/session"
+require "ZenfolioAPI/http"
+require "ZenfolioAPI/record"
+require "ZenfolioAPI/model/gallery"
+require "ZenfolioAPI/model/image"
+require "ZenfolioAPI/model/exif_tag"
+require "ZenfolioAPI/model/access_descriptor"
+require "ZenfolioAPI/model/group"
+require "ZenfolioAPI/model/group_element"
+require "ZenfolioAPI/model/message"
+require "ZenfolioAPI/model/user"
+
+module ZenfolioAPI
+
+	# General Zenfolio error
+	class ZenfolioAPIError < StandardError
+	end
+
+	# Zenfolio Session Error
+	class ZenfolioAPISessionError < StandardError
+	end
+
+	# User Authentication Error
+	class ZenfolioAPIAuthenticationError < StandardError
+	end
+end

data/lib/ZenfolioAPI/authentication.rb

@@ -0,0 +1,25 @@
+module ZenfolioAPI
+	class Authentication
+
+		attr_accessor :token
+
+		# Connect to the Zenfolio API
+		#
+		# @author David Slone
+		def initialize username,password
+			@api_url = "http://api.zenfolio.com/api/1.7/zfapi.asmx"
+			@username = username
+			@password = password
+
+
+			connection = ZenfolioAPI::HTTP.new()
+			@response = connection.POST('AuthenticatePlain', [username, password])
+			
+			# Unable to authenticate the user. Return error code from server
+			raise ZenfolioAPI::ZenfolioAPIAuthenticationError, @response['error'] if !@response['error'].nil?
+
+			@token = @response['result']
+		end
+
+	end
+end

data/lib/ZenfolioAPI/http.rb

@@ -0,0 +1,30 @@
+module ZenfolioAPI
+	class HTTP
+
+		def initialize
+			@api_url = "https://api.zenfolio.com/api/1.7/zfapi.asmx"
+		end
+
+		#
+		#
+		# @author David Slone
+		def POST method, params = {}, token = nil
+			@api_body = {:method => method, :params => params, :id => 1}
+
+			url = URI.parse(@api_url) 
+			post = Net::HTTP::Post.new(url.path) 
+			http = Net::HTTP.new(url.host, url.port)
+			http.use_ssl = true
+			#http.set_debug_output $stderr
+
+			post['X-Zenfolio-User-Agent'] = 'Acme PhotoEdit plugin for Zenfolio v1.0'
+			post['User-Agent'] = 'Acme PhotoEdit plugin for Zenfolio v1.0'
+			post['X-Zenfolio-Token'] = token unless token.nil?
+			post.content_type = 'application/json'
+			post.body = @api_body.to_json
+
+			response = http.start {|http| http.request(post) }
+			@body = JSON.parse(response.body)
+		end
+	end
+end

data/lib/ZenfolioAPI/model/access_descriptor.rb

@@ -0,0 +1,13 @@
+module ZenfolioAPI
+	class Model
+		class AccessDescriptor < ZenfolioAPI::Record
+			attr_reader :realm_id
+			attr_reader :access_type
+			attr_reader :access_mask
+			attr_reader :viewers
+			attr_reader :is_derived
+			attr_reader :password_hint
+			attr_reader :src_password_hint
+		end
+	end
+end

data/lib/ZenfolioAPI/model/exif_tag.rb

@@ -0,0 +1,10 @@
+module ZenfolioAPI
+	class Model
+		class ExifTag < ZenfolioAPI::Record
+
+			attr_reader :id
+			attr_reader :value
+			attr_reader :display_value
+		end
+	end
+end

data/lib/ZenfolioAPI/model/gallery.rb

@@ -0,0 +1,34 @@
+module ZenfolioAPI
+	class Model
+		class Gallery < ZenfolioAPI::Record
+			attr_reader :id
+			attr_reader :type
+			attr_reader :caption
+			attr_reader :created_on
+			attr_reader :modified_on
+			attr_reader :photo_count
+			attr_reader :image_count
+			attr_reader :video_count
+			attr_reader :photo_bytes
+			attr_reader :views
+			attr_reader :type
+			attr_reader :featured_index
+			attr_reader :title_photo
+			attr_reader :is_random_title_photo
+			attr_reader :parent_groups
+			attr_reader :title
+			attr_reader :keywords
+			attr_reader :upload_url
+			attr_reader :video_upload_url
+			attr_reader :owner
+			attr_reader :page_url
+			attr_reader :mailbox_id
+			attr_reader :text_cn
+			attr_reader :photo_list_cn
+			attr_reader :group_index
+			attr_reader :hide_branding
+
+			attr_accessor :photos
+		end
+	end
+end

data/lib/ZenfolioAPI/model/group.rb

@@ -0,0 +1,27 @@
+module ZenfolioAPI
+	class Model
+		class Group < ZenfolioAPI::Record
+			attr_reader :id
+			attr_reader :created_on
+			attr_reader :modified_on
+			attr_reader :page_url
+			attr_reader :tile_photo
+			attr_reader :mailbox_id
+			attr_reader :immediate_children_count
+			attr_reader :text_cn
+
+			# Level 2 fields
+			attr_reader :caption
+
+			# Full Level fields
+			attr_reader :collection_count
+			attr_reader :sub_group_count
+			attr_reader :gallery_count
+			attr_reader :photo_count
+			attr_reader :parent_groups
+
+			# Other fields
+			attr_reader :elements
+		end
+	end
+end

data/lib/ZenfolioAPI/model/group_element.rb

@@ -0,0 +1,11 @@
+module ZenfolioAPI
+	class Model
+		class GroupElement < ZenfolioAPI::Record
+			attr_reader :id
+			attr_reader :group_index
+			attr_reader :title
+			attr_reader :access_descriptor
+			attr_reader :owner
+		end
+	end
+end

data/lib/ZenfolioAPI/model/image.rb

@@ -0,0 +1,45 @@
+module ZenfolioAPI
+	class Model
+		class Image < ZenfolioAPI::Record
+
+			#
+			# Level 1 Fields
+			#
+			attr_reader :id
+			attr_reader :width
+			attr_reader :height
+			attr_reader :sequence
+			attr_reader :access_descriptor
+			attr_reader :owner
+			attr_reader :title
+			attr_reader :mime_type
+			attr_reader :views
+			attr_reader :size
+			attr_reader :gallery
+			attr_reader :original_url
+			attr_reader :url_core
+			attr_reader :url_host
+			attr_reader :url_token
+			attr_reader :page_url
+			attr_reader :mailbox_id
+			attr_reader :text_cn
+			attr_reader :flags
+			attr_reader :is_video
+			attr_reader :duration
+
+			#
+			# Level 2 Fields
+			#
+			attr_reader :caption
+			attr_reader :file_name
+			attr_reader :uploaded_on
+			attr_reader :taken_on
+			attr_reader :keywords
+			attr_reader :categories
+			attr_reader :copyright
+			attr_reader :rotation
+			attr_reader :exif_tags
+			attr_reader :short_exif
+		end
+	end
+end

data/lib/ZenfolioAPI/model/message.rb

@@ -0,0 +1,14 @@
+module ZenfolioAPI
+	class Model
+		class Gallery < ZenfolioAPI::Record
+			attr_reader :index
+			attr_reader :mailbox_id
+			attr_reader :posted_on
+			attr_reader :poster_login_name
+			attr_reader :poster_url
+			attr_reader :poster_email
+			attr_reader :body
+			attr_reader :is_private
+		end
+	end
+end

data/lib/ZenfolioAPI/model/user.rb

@@ -0,0 +1,34 @@
+module ZenfolioAPI
+	class Model
+		class User < ZenfolioAPI::Record
+			attr_reader :login_name
+			attr_reader :display_name
+			attr_reader :first_name
+			attr_reader :last_name
+			attr_reader :primary_email
+			attr_reader :bio_photo
+			attr_reader :bio
+			attr_reader :views
+			attr_reader :gallery_count
+			attr_reader :collection_count
+			attr_reader :photo_count
+			attr_reader :photo_bytes
+			attr_reader :user_since
+			attr_reader :last_updated
+			attr_reader :public_address
+			attr_reader :personal_address
+			attr_reader :recent_photo_sets
+			attr_reader :featured_photo_sets
+			attr_reader :root_group
+			attr_reader :referral_code
+			attr_reader :expires_on
+			attr_reader :balance
+			attr_reader :domain_name
+			attr_reader :storage_quota
+			attr_reader :photo_bytes_quota
+			attr_reader :video_bytes_quota
+			attr_reader :video_duration_quota
+			attr_reader :hierarchy_cn
+		end
+	end
+end

data/lib/ZenfolioAPI/record.rb

@@ -0,0 +1,23 @@
+module ZenfolioAPI
+	class Record
+		def initialize params
+			return if params.nil?
+
+			params.each do |key, value|
+				name = key.to_s
+				instance_variable_set("@#{name}", value) if respond_to?(name)
+			end
+		end
+
+		# Display Gallery is JSON format
+		#
+		# @author David Slone
+		def to_json
+			self.instance_variable_hash
+		end
+
+		def instance_variable_hash
+			Hash[instance_variables.map { |name| [name[1..-1], instance_variable_get(name)] } ]
+		end
+	end
+end

data/lib/ZenfolioAPI/session.rb

@@ -0,0 +1,106 @@
+require 'date'
+
+module ZenfolioAPI
+	class Session
+		attr_accessor :galleries
+		attr_accessor :photos
+		attr_accessor :groups
+
+		# Create the Zenfolio Session
+		#
+		# @author David Slone
+		def initialize username, password
+			@username = username
+			@password = password
+			@auth = ZenfolioAPI::Authentication.new(username, password)
+
+			@galleries = []
+			@photos = []
+			@groups = []
+		end
+
+		# Performs the API request to the Zenfolio server
+		#
+		# @author David Slone
+		def api_request method, params
+			connection = ZenfolioAPI::HTTP.new()
+			@response = connection.POST(method, params, @auth.token)
+		end
+
+		# The LoadGroupHierarchy method obtains a snapshot of the entire photoset group hierarchy of the specified user.
+		#
+		# @author David Slone
+		# @return [Hash] Returns a hash that contains the Galleries and Groups at the top level for a users account.
+		def list_galleries
+			@response = api_request 'LoadGroupHierarchy', [@username]
+
+			@response['result']['Elements'].each do |value|
+				if value['$type'] == "PhotoSet"
+					@galleries << ZenfolioAPI::Model::Gallery.new(:id => value['Id'], :type => value['$type'], :caption => value['Caption'], 
+						:created_on => value['CreatedOn']['Value'], :modified_on => value['ModifiedOn']['Value'], :photo_count => value['PhotoCount'],
+						:image_count => value['ImageCount'], :video_count => value['VideoCount'], :photo_bytes => value['PhotoBytes'], :views => value['Views'],
+						:featured_index => value['FeaturedIndex'], :is_random_title_photo => value['IsRandomTitlePhoto'], :upload_url => value['UploadUrl'],
+						:video_upload_url => value['VideoUploadUrl'], :page_url => value['PageUrl'], :mailbox_id => value['MailboxId'], :text_cn => value['TextCn'], 
+						:photo_list_cn => value['PhotoListCn'], :group_index => value['GroupIndex'], :title => value['Title'], :owner => value['Owner'])
+				elsif value['$type'] == "Group"	
+					elements = []
+					value['Elements'].each do |element|
+						elements << ZenfolioAPI::Model::Gallery.new(:id => element['Id'], :type => element['$type'], :caption => element['Caption'], 
+							:created_on => element['CreatedOn']['Value'], :modified_on => element['ModifiedOn']['Value'], :photo_count => element['PhotoCount'],
+							:image_count => element['ImageCount'], :video_count => element['VideoCount'], :photo_bytes => element['PhotoBytes'], :views => element['Views'],
+							:featured_index => element['FeaturedIndex'], :is_random_title_photo => element['IsRandomTitlePhoto'], :upload_url => element['UploadUrl'],
+							:video_upload_url => element['VideoUploadUrl'], :page_url => element['PageUrl'], :mailbox_id => element['MailboxId'], :text_cn => element['TextCn'], 
+							:photo_list_cn => element['PhotoListCn'], :group_index => element['GroupIndex'], :title => element['Title'], :owner => element['Owner'])
+					end
+
+					@groups << ZenfolioAPI::Model::Group.new(:id => value['Id'], :created_on => value['CreatedOn']['Value'], :modified_on => value['ModifiedOn']['Value'], 
+						:page_url => value['PageUrl'], :mailbox_id => value['MailboxId'], :immediate_children_count => value['ImmediateChildrenCount'], :text_cn => value['TextCn'],
+						:caption => value['Caption'], :collection_count => value['CollectionCount'], :sub_group_count => value['SubGroupCount'], :gallery_count => value['GalleryCount'],
+						:photo_count => value['PhotoCount'], :parent_groups => value['ParentGroups'], :elements => elements)
+				end
+			end
+
+			{:galleries => @galleries, :groups => @groups}
+		end
+
+		# List images for a specific gallery
+		#
+		# @author David Slone
+		# @param [Integer] gallery_id 64-bit identifier of the photoset/gallery to load
+		# @param [String] info_level Specifies which PhotoSet snapshot fields to return. This parameter is new in API version 1.4.
+		# @param [String] include_photos Specifies whether to return photoset photos. This parameter is new in API version 1.4.
+		def images_for_gallery gallery_id, info_level = "Full", include_photos = "true"
+			@response = api_request 'LoadPhotoSet', [gallery_id, info_level, include_photos]
+			raise ZenfolioAPI::ZenfolioAPISessionError, @response['error']['message'] if @response['result'].nil? && @response['error'].length > 0
+
+			@response['result']['Photos'].each do |value|
+				access_descriptor = ZenfolioAPI::Model::AccessDescriptor.new(:realm_id => value['AccessDescriptor']['RealmId'], 
+					:access_type => value['AccessDescriptor']['AccessType'], :is_derived => value['AccessDescriptor']['IsDerived'], 
+					:access_mask => value['AccessDescriptor']['AccessMask'], :password_hint => value['AccessDescriptor']['PasswordHint'], 
+					:src_password_hint => value['AccessDescriptor']['SrcPasswordHint'])
+
+				@photos << ZenfolioAPI::Model::Image.new(:id => value['Id'], :width => value['Width'], :height => value['Height'], :sequence => value['Sequence'], 
+					:access_descriptor => access_descriptor, :owner => value['Owner'], :title => value['Title'], :mime_type => value['MimeType'], 
+					:size => value['Size'], :gallery => value['Gallery'], :original_url => value['OriginalUrl'], :url_core => value['UrlCore'], 
+					:url_host => value['UrlHost'], :url_token => value['UrlToken'], :page_url => value['PageUrl'], :mailbox_id => value['MailboxId'], 
+					:text_cn => value['TextCn'], :flags => value['Flags'], :is_video => value['IsVideo'], :duration => value['Duration'], :caption => value['Caption'], 
+					:file_name => value['FileName'], :uploaded_on => value['UploadedOn']['Value'], :taken_on => value['TakenOn']['Value'], :keywords => value['keywords'], 
+					:categories => value['Categories'], :copyright => value['Copyright'], :rotation => value['Rotation'], :exif_tags => value['ExifTags'], :short_exif => value['ShortExif'])
+			end
+
+			@photos
+		end
+
+		# The LoadMessages method loads comments or guestbook entries posted to a mailbox.
+		#
+		# @author David Slone
+		def get_mailbox_messages mailbox_id, posted_since = "", include_deleted = "false"
+			posted_since = Date.today if posted_since.length == 0
+
+			@response = api_request 'LoadMessages', [mailbox_id, posted_since, include_deleted]
+			raise ZenfolioAPI::ZenfolioAPISessionError, @response['error']['message'] if @response['result'].nil? && @response['error'].length > 0
+
+			
+		end
+	end
+end

data/lib/ZenfolioAPI/version.rb

@@ -0,0 +1,3 @@
+module ZenfolioAPI
+  VERSION = "0.0.2"
+end

data/spec/ZenfolioAPI_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe ZenfolioAPI do
+	session = ZenfolioAPI::Session.new('punndit','punndit1024')
+
+	it "Should connect to API server" do
+		session.should_not be_nil
+	end
+
+	it "should list galleries for user" do
+		session.list_galleries
+	end
+
+	it "should raise exception for incorrect gallery/collection id" do
+		expect { session.images_for_gallery 5 }.to raise_error
+
+	end
+
+	it "should list photos for a gallery" do
+		session.images_for_gallery 562597393410974837
+	end
+
+	it "should list photos for a group" do
+		session.list_galleries
+		session.groups.each do |group|
+			group.elements.each do |element|
+				session.images_for_gallery element.id
+				session.photos.should_not be_nil
+			end
+		end
+	end
+
+	it "should list messages in inbox" do
+		session.list_galleries
+		inbox = session.get_mailbox_messages session.galleries.first.mailbox_id
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'ZenfolioAPI'
+require "net/http"
+require "uri"
+require "json"
+
+RSpec.configure do |config|
+	config.color_enabled = true
+	config.formatter = 'documentation'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: ZenfolioAPI
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- David Slone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Basic implementation of the Zenfolio API.
+email:
+- dbslone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ZenfolioAPI.gemspec
+- lib/ZenfolioAPI.rb
+- lib/ZenfolioAPI/authentication.rb
+- lib/ZenfolioAPI/http.rb
+- lib/ZenfolioAPI/model/access_descriptor.rb
+- lib/ZenfolioAPI/model/exif_tag.rb
+- lib/ZenfolioAPI/model/gallery.rb
+- lib/ZenfolioAPI/model/group.rb
+- lib/ZenfolioAPI/model/group_element.rb
+- lib/ZenfolioAPI/model/image.rb
+- lib/ZenfolioAPI/model/message.rb
+- lib/ZenfolioAPI/model/user.rb
+- lib/ZenfolioAPI/record.rb
+- lib/ZenfolioAPI/session.rb
+- lib/ZenfolioAPI/version.rb
+- spec/ZenfolioAPI_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Currently just a basic implementation of the Zenfolio API with features to
+  list all galleries and photos, and get all the information about a gallery or photo.
+test_files:
+- spec/ZenfolioAPI_spec.rb
+- spec/spec_helper.rb
+has_rdoc: