andhapp-players 1.0.0

data/README.markdown

@@ -0,0 +1,8 @@
+# Players: Download images from a webpage and convert them into a .psd file with layers
+
+Players (when complete) would allow to download images from a webpage and create a photoshop layered file from the images. Players basically means "Photoshop Layers"
+
+## Installing
+
+  # Currently being worked on
+

data/Rakefile

@@ -0,0 +1,17 @@
+# players-rspec
+
+%w{rake rake/testtask rake/rdoctask rcov/rcovtask}.each{|x| require x}
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "players"
+    gem.summary = "Its a simple gem that enables the image download from a webpage and creation of a photoshop layered file from those images"
+    gem.email = "anuj@andhapp.com"
+    gem.homepage = "http://github.com/andhapp/players"
+    gem.description = "Players - Photoshop Layers"
+    gem.authors = ["Anuj Dutta"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 1
+:minor: 0 

data/bin/players

@@ -0,0 +1,8 @@
+app_path = ARGV.first
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", 'lib')
+require 'pscript'
+
+player = Players::Pscript.new
+player.init
+player.run

data/lib/convert_images_to_photoshop_layers.vbs

@@ -0,0 +1,44 @@
+
+Dim appRef
+Dim originalRulerUnits
+Dim docRef, artLayerRef, imageLayerRef, currentDoc 
+Dim fso, folder, files
+
+Set appRef = CreateObject("Photoshop.Application")
+
+' Remember current unit settings and then set units to the value expected by this script
+originalRulerUnits = appRef.Preferences.RulerUnits
+appRef.Preferences.RulerUnits = 2
+
+Set fso =  CreateObject("Scripting.FileSystemObject")
+Set folder = fso.GetFolder(Wscript.Arguments(0))
+Set files = folder.Files
+
+Set docRef = appRef.Documents.Add(2, 4)
+
+For each file In files
+	Set imageLayerRef = docRef.ArtLayers.Add
+	imageLayerRef.Kind = 1
+
+	Set currentDoc = appRef.Open(folder + "\" + file.Name)
+	currentDoc.ArtLayers("Background").Copy
+	currentDoc.Close()
+	docRef.Paste
+
+Next
+
+' Restore unit setting
+appRef.Preferences.RulerUnits = originalRulerUnits
+
+Dim photoshopSaveOptions
+Set photoshopSaveOptions = CreateObject("Photoshop.PhotoshopSaveOptions")
+photoshopSaveOptions.Layers = True
+photoshopSaveOptions.AlphaChannels = True
+
+appRef.ActiveDocument.SaveAs folder + "\" + "collated_psd_version", _
+photoshopSaveOptions, True, 2
+
+' don�t save anything we did
+appRef.ActiveDocument.Close(2)
+
+appRef.Quit

data/lib/options.yaml

@@ -0,0 +1,5 @@
+website_address: 'http://geekandpoke.smugmug.com/gallery/5297189_ToNCK#323502743_kns4p'  
+destination_folder: final
+destination_filename: final.psd
+extension_of_files_to_download: jpg # default jpg
+close_photoshop_after_processing: 2 # no(0) | yes(2) # default yes(2)

data/lib/pconstants.rb

@@ -0,0 +1,8 @@
+module Players
+  module Pconstants
+    OPTIONS_FILE = 'options.yaml'
+    HTTP = 'http://'
+    URL_SEPERATOR = '/'
+    INIT_DIR = 'players-init'
+  end
+end

data/lib/players.rb

@@ -0,0 +1,106 @@
+%w(net/http hpricot ftools yaml).each {|x| require x}
+require File.join(File.dirname(__FILE__), '..', 'lib', 'pconstants')
+
+module Players
+
+  class Pscript
+
+    include Players::Pconstants
+
+    attr_reader :options
+    
+    def sinit
+      create_player_init_directory
+      copy_options_file_in_init_dir
+      load_options
+    end
+
+    def run
+      response = make_http_request(@options["website_address"])
+      all_image_elements = collect_source_of_image_element(reponse)
+      required_image_elements = select_the_supplied_extension_elements(all_image_elements, @options["extension_of_files_to_download"])
+      create_destination_directory("#{Pconstants::INIT_DIR}#{File::SEPARATOR}#{@options['destination_folder']}")
+      elements_with_full_url = build_full_url(get_host_name_from_protocol_sanitised_url(get_protocol_sanitised_url(@options["website_address"])), required_image_elements)
+      download_the_images("#{Pconstants::INIT_DIR}#{File::SEPARATOR}#{@options['destination_folder']}", elements_with_full_url)
+      make_call_to_external_vb_script("#{Pconstants::INIT_DIR}#{File::SEPARATOR}#{@options['destination_folder']}")
+    end
+
+    def create_player_init_directory
+      FileUtils.mkdir_p("#{Pconstants::INIT_DIR}")
+    end
+
+    def copy_options_file_in_init_dir
+      File.copy(File.join(File.dirname(__FILE__), '..', 'lib', "#{Pconstants::OPTIONS_FILE}"), "#{Pconstants::INIT_DIR}#{File::SEPARATOR}#{Pconstants::OPTIONS_FILE}")
+    end
+
+    def load_options(name = nil)
+      fail "no options file to load" if !files_in_a_folder(Pconstants::INIT_DIR).index("#{name || Pconstants::OPTIONS_FILE}")
+      @options = YAML::load( File.open( File.join(Pconstants::INIT_DIR, "#{Pconstants::OPTIONS_FILE}") ) )
+    end
+
+    def files_in_a_folder(name)
+      Dir.entries(name).each {|x| [] << x if !File.directory?(x)}
+    end
+    
+    def get_protocol_sanitised_url(url)
+      url.split("#{Pconstants::HTTP}").last  
+    end
+
+    def get_host_name_from_protocol_sanitised_url(url)
+      url.split("#{Pconstants::URL_SEPERATOR}").first  
+    end
+    
+    def get_remaining_url_from_protocol_sanitised_url(url)
+      url.sub(/#{get_host_name_from_protocol_sanitised_url(url)}/, '')
+    end
+
+    def make_http_request(url)
+      url = get_protocol_sanitised_url(url)
+      main_host_name = get_host_name_from_protocol_sanitised_url(url)
+      remaining_address = get_remaining_url_from_protocol_sanitised_url(url)
+      result = Net::HTTP.get_response(main_host_name, remaining_address)
+      fail "could not connect to the site" if result.nil?
+      result.body
+    end
+
+    def collect_source_of_image_element(response)
+      doc = Hpricot(response)
+      all_elements = doc.search("img")
+      all_elements.each {|elem| [] << elem.get_attribute("src")}
+    end
+
+    def select_the_supplied_extension_elements(elements, extension)
+      elements.delete_if {|src| !src.include?(".#{extension}")}
+    end
+
+    def create_destination_directory(name)
+      FileUtils.mkdir_p(name)
+    end
+
+    def build_full_url(host_name, elements)
+      elements.map! {|elem| elem = host_name + elem}
+    end
+
+    def get_image_name(value)
+      value[value.rindex("#{Pconstants::URL_SEPERATOR}")+1..value.length]
+    end
+
+    def download_the_images(destination_dir, elements)
+      elements.each {|elem|
+        host = get_host_name_from_protocol_sanitised_url(elem)
+        query_string = get_remaining_url_from_protocol_sanitised_url(elem)
+        image_name = get_image_name(query_string) 
+        Net::HTTP.start(host) { |http|
+          resp = http.get(query_string)
+          open(destination_dir + "#{File::SEPARATOR}" + image_name, "wb") { |file| file.write(resp.body) }
+        }
+      }
+    end
+    
+    def make_call_to_external_vb_script(directory_name)
+      system "cscript convert_images_to_photoshop_layers.vbs #{directory_name}"
+    end
+    
+  end
+
+end

data/players.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{players}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anuj Dutta"]
+  s.date = %q{2009-05-04}
+  s.default_executable = %q{players}
+  s.description = %q{Players - Photoshop Layers}
+  s.email = %q{anuj@andhapp.com}
+  s.executables = ["players"]
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+    "Rakefile",
+    "VERSION.yml",
+    "bin/players",
+    "lib/convert_images_to_photoshop_layers.vbs",
+    "lib/options.yaml",
+    "lib/pconstants.rb",
+    "lib/players.rb",
+    "players.gemspec",
+    "test/ts_players.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/andhapp/players}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Its a simple gem that enables the image download from a webpage and creation of a photoshop layered file from those images}
+  s.test_files = [
+    "test/ts_players.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/ts_players.rb

@@ -0,0 +1,111 @@
+%w(test/unit redgreen shoulda rr fileutils ftools).each{|x| require x}
+require File.join(File.dirname(__FILE__), '..', 'lib', 'players')
+
+class TestPlayers < Test::Unit::TestCase
+
+  include RR::Adapters::TestUnit unless include?(RR::Adapters::TestUnit)
+  
+  def files_in_a_folder(name)
+    Dir.entries(name).each {|x| [] << x if !File.directory?(x)}
+  end
+
+  def dir_in_a_folder(name)
+    Dir.entries(name).each {|x| [] << x if File.directory?(x)} 
+  end
+
+  context "" do
+    setup do
+      @player = Players::Pscript.new
+      @player.create_player_init_directory
+      @player.copy_options_file_in_init_dir
+      @options = @player.load_options
+      
+      @response = '<div id="photos">
+        <div id="thumbnails" class="leftColumn">
+          <div class="photo" style="visibility: hidden" id="TinyPhotoSample"><a href="#"><img src="/img/spacer.gif" width="100" height="100" border="0" class="imgBorder" /></a></div>
+          <div class="photo size_Thumb" style="visibility: hidden" id="ThumbPhotoSample"><a href="#"><img src="/img/spacer.jpg" width="150" height="150" border="0" class="imgBorder" /></a></div>
+        </div>
+      </div>'
+
+    end
+
+    should "initialise the player script in a folder called players in the directory where it is run" do 
+     dir_in_a_folder(".").include?("players-init")
+    end
+
+    should "copy the options file in this folder and use this options file" do
+     files_in_a_folder(".").include?("options.yaml")
+    end
+
+    should "raise exception if the options file is not present" do
+      assert_raises(RuntimeError) {@player.load_options('some_options.yaml')}
+    end
+
+    should "load options file and populate the options" do
+      assert_not_nil @options
+      assert_equal @options["website_address"], 'http://geekandpoke.smugmug.com/gallery/5297189_ToNCK#323502743_kns4p'
+      assert_equal @options["destination_folder"], 'final'
+      assert_equal @options["destination_filename"], 'final.psd'
+      assert_equal @options["extension_of_files_to_download"], 'jpg' 
+      assert_equal @options["close_photoshop_after_processing"], 2
+    end
+    
+    should "get protocal sanitised url" do
+      result_url = @player.get_protocol_sanitised_url("http://geekandpoke.smugmug.com/gallery/5297189_ToNCK#323502743_kns4p")
+      assert !result_url.include?("http://")
+    end
+
+    should "get the host name from protocol sanitised url" do
+      actual_host_name = @player.get_host_name_from_protocol_sanitised_url("geekandpoke.smugmug.com/gallery/5297189_ToNCK#323502743_kns4p")
+      assert_equal actual_host_name, "geekandpoke.smugmug.com"
+    end
+
+    should "get the remaining url and the querystrings" do
+      remaining_url = @player.get_remaining_url_from_protocol_sanitised_url("geekandpoke.smugmug.com/gallery/5297189_ToNCK#323502743_kns4p")
+      assert_equal remaining_url, "/gallery/5297189_ToNCK#323502743_kns4p"
+    end
+    
+    should "make net/http request and get response" do
+      response = @player.make_http_request('http://geekandpoke.smugmug.com/gallery/5297189_ToNCK#323502743_kns4p')
+      assert_not_nil response  
+    end
+    
+    should "collect all image (img) elements" do
+      elements = @player.collect_source_of_image_element(@response)
+      assert_equal elements.size(), 2
+    end
+    
+    should "select the supplied extension elements" do
+      refined_elements = @player.select_the_supplied_extension_elements(["/img/spacer.gif", "/img/spacer.jpg"], "jpg")
+      assert_equal refined_elements.size(), 1
+    end
+
+    should "create destination directory" do
+      @player.create_destination_directory("players-init#{File::SEPARATOR}test_final")
+      assert dir_in_a_folder("players-init").include?("test_final")
+    end
+    
+    should "build required images full url" do
+      @elements_with_full_url = @player.build_full_url("geekandpoke.smugmug.com", ["/img/spacer.gif", "/img/spacer.jpg"])
+      assert_equal @elements_with_full_url[0], "geekandpoke.smugmug.com/img/spacer.gif"
+      assert_equal @elements_with_full_url[1], "geekandpoke.smugmug.com/img/spacer.jpg"
+    end
+
+    should "get the image name" do
+      image_name = @player.get_image_name("/img/spacer.jpg")
+      assert_equal "spacer.jpg", image_name
+    end
+
+    should "download the images" do
+      @player.download_the_images(".", ["geekandpoke.smugmug.com/photos/323503251_vdoAH-Th.jpg"])
+      files_in_a_folder(".").include?("323503251_vdoAH-Th.jpg")
+    end
+
+    teardown do
+      FileUtils.rmtree("players-init") if test(?d, "players-init")
+      FileUtils.rm("323503251_vdoAH-Th.jpg") if File.exists?("323503251_vdoAH-Th.jpg")
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: andhapp-players
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Anuj Dutta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-04 00:00:00 -07:00
+default_executable: players
+dependencies: []
+
+description: Players - Photoshop Layers
+email: anuj@andhapp.com
+executables: 
+- players
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION.yml
+- bin/players
+- lib/convert_images_to_photoshop_layers.vbs
+- lib/options.yaml
+- lib/pconstants.rb
+- lib/players.rb
+- players.gemspec
+- test/ts_players.rb
+has_rdoc: true
+homepage: http://github.com/andhapp/players
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Its a simple gem that enables the image download from a webpage and creation of a photoshop layered file from those images
+test_files: 
+- test/ts_players.rb