go-picasa-go 0.0.1

data/README.rdoc

@@ -0,0 +1,135 @@
+=Go Picasa go
+
+Go Picasa go is intended as library written in ruby to manipulate 
+Picasa[http://picasaweb.google.com/] albums and photos in a easy way. The idea
+is to provide behaviors to ordinary objects so they can create, retrieve, 
+update and delete albums and photos in a more object oritented way, lefting 
+behind all the HTTP talk that was necessary previouly to interect with this service 
+provided by Google.
+
+This library was implemented based on the 
+Protocol Guide[http://code.google.com/intl/pt-BR/apis/picasaweb/docs/2.0/developers_guide_protocol.html] 
+version 2.0 of Picasa Web Albums Data API.
+
+Go Picasa go is still under heavy development but it's available for testing. 
+We will be glad if you can do some tests and give us your feedback. Thank you.
+
+==Quick Start
+
+On the command line, run the user_class generator to create a file with the authentication token and other stuff you need:
+
+  go-picasa-go user_class YourUserClass google_user_id, google_password
+  
+After running the command above, a file called "your_user_class.rb" will be 
+generated at the current folder you're at. The google user id and google password 
+are only necessary to generate the authentication token for further operation 
+with Go-picasa-go. It's also important for you to know that the password is only 
+used on this single operation. All other operations executed by the gem uses only 
+the authentication token generated. 
+
+==Usage
+  
+=== Your User
+
+  user = YourUserClass.new
+  
+===Working with albums
+  
+To create an album:
+
+  album = Picasa::DefaultAlbum.new
+  album.user = user
+  album.title = "Title"
+  album.summary = "Summary"
+  album.location = "Location"
+  album.keywords = "Keyword, another keyword"
+  album.access = 'private' # Other options: public, protected
+
+  album.picasa_save # Returns true or false
+  album.picasa_save! # Raise exception in case of not being able to save the album
+
+To update that album:
+
+  album.title = "Updating the title"
+
+  album.picasa_update # Returns true or false
+  album.picasa_update! # Raise exception in case of not being able to update the album
+
+To destroy an album:
+
+  album.picasa_destroy # Returns true or false
+  album.picasa_destroy! # Raise exception in case of not being able to destroy the album
+
+To retrieve all albums from an user:
+  
+  user.albums
+
+To retrieve one specific album
+  
+  user.find_album album.picasa_id
+  
+===Working with photos
+
+To create a new photo:
+  
+  photo = Picasa::DefaultPhoto.new
+  photo.album = album
+  photo.description = "Photo summary"
+  photo.file = File.open 'path/photo.jpg'
+  
+  photo.picasa_save # Returns true or false
+  photo.picasa_save! # Raise exception in case of not being able to save the photo
+  
+To update an existing photo:
+
+  photo.title = "Updating title"
+  photo.description = "Updating summary"
+  photo.file = File.open 'path/new_photo.jpg'
+  
+  photo.picasa_update # Returns true or false
+  photo.picasa_update! # Raise exception in case of not being able to update the photo
+  
+To destroy an existing photo:
+
+  photo.picasa_destroy # Returns true or false
+  photo.picasa_destroy! # Raise exception in case of not being able to delete the photo
+  
+To retrieve all photos from an album:
+
+  album.photos
+  
+To find an specific photo from an album:
+
+  album.find_photo photo.id
+  
+== More detailed configuration
+
+If you need your own classes to interact to Picasa you can do it like this:
+
+  class MyUser
+    act_as_picasa_user
+    has_many_picasa_albums :class_name => "MyAlbum"
+    
+    def picasa_id
+      'your_google_user_id'
+    end
+    
+    def auth_token
+      'DQAAAHsAAAAdMyvdNfPg_iTFD-T_u6bBb-9Be...'
+    end
+  end
+
+  class MyAlbum
+    acts_as_picasa_album
+    belongs_to_picasa_user :class_name => "MyUser"
+    has_many_picasa_photos :class_name => "MyPhoto"
+  end
+
+  class MyPhoto
+    acts_as_picasa_photo
+    belongs_to_picasa_album :class_name => "MyAlbum"
+  end
+
+We provided this kind of configuration so your classes can interact with other 
+frameworks like Rails and inherit from ActiveRecord::Base for example.
+

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "go-picasa-go"
+    gemspec.summary = "API to easly manipulate picasa albums and photos"
+    gemspec.description = "Go Picasa go is intended as library written in ruby to manipulate Picasa albums and photos in a easy way. The idea is to provide behaviors to ordinary objects so they can create, retrieve, update and delete albums and photos in a more object oritented way, lefting behind all the HTTP talk that was necessary previouly to interect with this service provided by Google."
+     
+    gemspec.add_dependency 'nokogiri', '>= 1.4.3.1'
+     
+    gemspec.email = "pedro.capaca@gmail.com"
+    gemspec.homepage = "http://github.com/capaca/go-picasa-go"
+    gemspec.authors = ["Pedro Dias"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/TODO

@@ -0,0 +1,10 @@
+- Tentar melhorar o desempenho das operações
+- Implement the update_attributes method for Picasa::Photo
+- Testar o erro na forma de navegação no xml sem namespaces
+- Verificar o esquema de atualização dos dados do album. Melhor usar o template?
+- Testar que o access está sendo setado no params ao atualizar um album
+- Testar que o access está sendo setado no params ao criar um novo album
+- Corrigir o problema do numero de parametros no method missing
+- Fazer o find lançar excessao caso não ache o registro.
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/go-picasa-go

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'go_picasa_go'
+
+class Generator
+  
+  def run args
+    @args = args
+    @generation = @args[0]
+    generate
+  end
+
+  private
+  
+  def generate
+    case @generation
+    when "user_class"
+     generate_user_class
+    when "auth_token"
+      generate_auth_token
+    else
+      puts "Usage:\n\tgo-picasa-go user_class [class_name]] [picasa_id] [password]\n\tgo-picasa-go auth_token [picasa_id] [password]"
+    end
+  end
+
+  def generate_user_class
+    file_name = @args[1]
+    picasa_id = @args[2]
+    password = @args[3]
+    
+    if validate file_name and validate picasa_id and validate password
+      UserClassGenerator.generate file_name, picasa_id, password
+      puts "File generated succefully!"
+    else
+      puts "Usage for user_class generation:\n\t go-picasa-go user_class [class_name] [picasa_id] [password]"
+    end
+  end
+    
+  def generate_auth_token
+    picasa_id = @args[1]
+    password = @args[2]
+    
+    if validate picasa_id and validate password
+      Picasa::Authentication.authenticate picasa_id, password
+    else
+      puts "Usage for auth_token generation:\n\t go-picasa-go auth_token [picasa_id] [password]"
+    end
+  end
+  
+  def validate arg
+    if arg and arg.length > 0
+      return true
+    end
+    false
+  end
+  
+end
+
+Generator.new.run ARGV
+
+
+
+

data/examples/rails-example/README

@@ -0,0 +1,243 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.