couchpack 0.1.2 → 0.2.1

data/Gemfile

@@ -1,7 +1,10 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-#   gem "activesupport", ">= 2.3.5"
+gem "json", "> 1.1.5"
+gem "typhoeus", "~>0.2"
+gem "thor", "~>0.14.0"
+gem "couchwatcher", "~>0.1.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -10,4 +13,5 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
+  gem "yard", ">= 0"
 end

data/Gemfile.lock

@@ -1,20 +1,37 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    couchwatcher (0.1.0)
+      json (> 1.1.5)
+      json (> 1.1.5)
+      typhoeus (~> 0.2)
+      typhoeus (~> 0.2)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    json (1.5.2)
+    mime-types (1.16)
     rake (0.8.7)
     rcov (0.9.9)
     shoulda (2.11.3)
+    thor (0.14.6)
+    typhoeus (0.2.4)
+      mime-types
+      mime-types
+    yard (0.7.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  couchwatcher (~> 0.1.0)
   jeweler (~> 1.5.2)
+  json (> 1.1.5)
   rcov
   shoulda
+  thor (~> 0.14.0)
+  typhoeus (~> 0.2)
+  yard

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Stephane Bellity and Kevin Malakoff
+Copyright (c) 2011 Kevin Malakoff
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -6,7 +6,8 @@ This gem is a tools to help packing couch documents for mobile devices. See http
     gem install couchpack
 
   Usage:
-    couchpack [-h <hostname>] [-p <port>] [-d <database>] [-a <document>] [-o <outfile filename>]
+    couchpack document [DOCUMENT_URL] [OUTFILE] --auto
+    Note: the optional --auto flag watches the couchdb document for changes and automatically repacks when changes are detected.
 
 What it does is strip out the "_id" and "_rev" fields so the document can be uploaded in place without being modified and generates a {document}.JSON file. 
 
@@ -25,5 +26,5 @@ It also strips out the "_rev" field and puts it in a {document}.VERSION file whi
 
 == Copyright
 
-Copyright (c) 2011 Stephane Bellity and Kevin Malakoff. See LICENSE.txt for further details.
+Copyright (c) 2011 Kevin Malakoff. See LICENSE.txt for further details.
 

data/Rakefile

@@ -18,11 +18,15 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{Couch document packing utility}
   gem.description = %Q{Use this gem to pack your couchdb document by stripping out the "_id" and "_rev" fields, and putting the "_rev" in a .version file. To be used with https://github.com/kmalakoff/phonegap-couchbase-xplatform}
   gem.email = "xmann.intl@gmail.com"
-  gem.authors = ["Stephane Bellity", "Kevin Malakoff"]
+  gem.authors = ["Kevin Malakoff"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-   gem.add_runtime_dependency 'json', '> 1.1.5'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+   gem.add_dependency 'json', '> 1.1.5'
+   gem.add_dependency 'typhoeus', '~>0.2'
+   gem.add_dependency 'thor', '~>0.14.0'
+   gem.add_dependency 'couchwatcher', '~>0.1.0'
+   gem.files.include 'lib/couchpack/cli.rb'
+   gem.add_development_dependency "yard", ">= 0"
 end
 Jeweler::RubygemsDotOrgTasks.new
 
@@ -42,12 +46,11 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "couchpack #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
 end

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.1

data/bin/couchpack

@@ -1,108 +1,5 @@
 #!/usr/bin/env ruby
 
-require "rubygems"
-require 'optparse'
-require "json"
-require "fileutils"
+require 'couchpack'
 
-
-begin
-  # Save ARGV in case someone wants to use it later
-  ORIGINAL_ARGV = ARGV.dup
-
-  options = {:hostname => "localhost", :port => 5984, :db => "couchapp"}
-
-  opts = OptionParser.new do |opts|
-    opts.banner = <<-EOF
-  Usage:
-    Starting:
-      couchpack [-h <hostname>] [-p <port>] [-d <database>] [-a <document>] [-o <outfile filename>]
-      
-    Options:
-  EOF
-  
-    
-    opts.on("-hHOSTNAME", "--hostname HOSTNAME", "Hostname of the CouchDB server") do |x|
-      options[:hostname] = x
-    end
-    
-    opts.on("-pPORT", "--port PORT", "Port of the CouchDB server") do |x|
-      options[:port] = x
-    end
-    
-    opts.on("-dDB", "--database DB", "Couch document database name on the CouchDB server") do |x|
-      options[:db] = x
-    end
-
-    opts.on("-aDOC", "--adocument DOC", "Couch document name on the CouchDB server") do |x|
-      options[:doc] = x
-    end
-    
-    opts.on("-oOUTFILE", "--outfile OUTFILE", "Path of the output file") do |x|
-      options[:outfile] = x
-    end
-    
-  end
-  
-  opts.parse!
-  
-  puts "CouchPack options: #{options.inspect}"
-  
-rescue => err
-
-end
-
-# default is using the database name for the document
-if options[:doc].nil?
-   options[:doc] = options[:db]
-end
-
-# default is using the document name for the output file
-if options[:outfile].nil?
-   options[:outfile] = options[:db]
-end
-options[:outfile] = options[:outfile].gsub("//", "")
-
-tmp_file = "/tmp/couchpack-#{options[:db]}-#{Time.now.to_i}.json"
-cmd = "curl -o #{tmp_file} \"http://#{options[:hostname]}:#{options[:port]}/#{options[:db]}/#{options[:doc]}?attachments=true\""
-
-puts "CMD : #{cmd}"
-
-`#{cmd}`
-
-json = JSON.parse(open(tmp_file).read)
-
-error = json["error"]
-
-# success
-if error.nil?
-  version = json["_rev"]
-
-  json.delete("_rev")
-  json.delete("_id")
-
-  # make the directory
-  filename = File.basename(options[:outfile])
-  directoryname = File.dirname(options[:outfile])
-  puts "DIRECTORY: " + directoryname + "\n" 
-  puts "FILENAME: " + filename + "\n" 
-  if (directoryname != "")
-    FileUtils.mkdir_p(directoryname)
-  end
-
-  f = open(options[:outfile] + ".json", "w")
-  f.write(json.to_json)
-  f.close
-
-  f = open(options[:outfile] + ".version", "w")
-  f.write(version)
-  f.close
-
-  puts "Success: created bundled document: #{options[:outfile]}.json and version file: #{options[:outfile]}.version."
-  puts "Don't forget to add them as a resource to your project!"
-# failure
-else
-  puts "Failed: couch responded with: #{json.inspect}"
-end
-
-FileUtils.rm(tmp_file)
+CouchPack::CLI.start

data/couchpack.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couchpack}
-  s.version = "0.1.2"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Stephane Bellity", "Kevin Malakoff"]
-  s.date = %q{2011-06-16}
+  s.authors = ["Kevin Malakoff"]
+  s.date = %q{2011-06-19}
   s.default_executable = %q{couchpack}
   s.description = %q{Use this gem to pack your couchdb document by stripping out the "_id" and "_rev" fields, and putting the "_rev" in a .version file. To be used with https://github.com/kmalakoff/phonegap-couchbase-xplatform}
   s.email = %q{xmann.intl@gmail.com}
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "bin/couchpack",
     "couchpack.gemspec",
     "lib/couchpack.rb",
+    "lib/couchpack/cli.rb",
     "test/helper.rb",
     "test/test_couchpack.rb"
   ]
@@ -46,24 +47,51 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, ["> 1.1.5"])
+      s.add_runtime_dependency(%q<typhoeus>, ["~> 0.2"])
+      s.add_runtime_dependency(%q<thor>, ["~> 0.14.0"])
+      s.add_runtime_dependency(%q<couchwatcher>, ["~> 0.1.0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_runtime_dependency(%q<json>, ["> 1.1.5"])
+      s.add_runtime_dependency(%q<typhoeus>, ["~> 0.2"])
+      s.add_runtime_dependency(%q<thor>, ["~> 0.14.0"])
+      s.add_runtime_dependency(%q<couchwatcher>, ["~> 0.1.0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
     else
+      s.add_dependency(%q<json>, ["> 1.1.5"])
+      s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+      s.add_dependency(%q<thor>, ["~> 0.14.0"])
+      s.add_dependency(%q<couchwatcher>, ["~> 0.1.0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<json>, ["> 1.1.5"])
+      s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+      s.add_dependency(%q<thor>, ["~> 0.14.0"])
+      s.add_dependency(%q<couchwatcher>, ["~> 0.1.0"])
+      s.add_dependency(%q<yard>, [">= 0"])
     end
   else
+    s.add_dependency(%q<json>, ["> 1.1.5"])
+    s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+    s.add_dependency(%q<thor>, ["~> 0.14.0"])
+    s.add_dependency(%q<couchwatcher>, ["~> 0.1.0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<json>, ["> 1.1.5"])
+    s.add_dependency(%q<typhoeus>, ["~> 0.2"])
+    s.add_dependency(%q<thor>, ["~> 0.14.0"])
+    s.add_dependency(%q<couchwatcher>, ["~> 0.1.0"])
+    s.add_dependency(%q<yard>, [">= 0"])
   end
 end
 

data/lib/couchpack/cli.rb

@@ -0,0 +1,48 @@
+require 'thor'
+require 'thor/actions'
+require 'couchwatcher'
+require 'couchpack'
+
+module CouchPack
+
+  class CLI < ::Thor
+    include Thor::Actions
+
+    class_option "version",
+        :type => :boolean,
+        :aliases => '-v',
+        :banner => "print version and exit"
+
+    default_task :help
+
+    def initialize(*)
+      super
+      if options[:version]
+        say "couchpack #{::CouchPack::VERSION}", :green
+        exit
+      end
+    end
+
+    desc 'document [DOCUMENT_URL] [OUTFILE]', 'extracts the document from a couchdb and prepares for upload to Couchbase'
+    def document(document_url, outfile)
+      auto = options[:auto]
+
+      # pack now
+      ::CouchPack::CouchPack::pack_document(document_url, outfile)
+
+      # watch for changes
+      if auto
+        couch_watcher = CouchWatcher::CouchWatcher.new()
+        couch_watcher.add_document_watcher(document_url, false) {|url, id, rev| ::CouchPack::CouchPack::pack_document(document_url, outfile)}
+        couch_watcher.start_watching(false)
+
+        # keep the watcher running
+        while(true)
+          sleep(1000)
+        end        
+      end
+    end
+    method_option '--auto', :for => :document, :type => :boolean, :default => false,
+      :banner => 'watches a couchdb document for changes and repacks when it changes'
+  end
+end

data/lib/couchpack.rb

@@ -0,0 +1,68 @@
+require 'json'
+require 'typhoeus'
+require 'thor/shell/basic'
+require "fileutils"
+require 'couchpack/cli'
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__))))
+
+module CouchPack
+  VERSION = '0.2.0'
+
+  class CouchPack
+    # shortcut to say
+    def self.say(message, color=nil)
+      @shell ||= Thor::Shell::Basic.new
+      @shell.say message, color
+    end
+
+    def self.pack_document(document_url, outfile)
+      
+#      puts "GET #{document_url}"
+      document_url_with_attachments = document_url
+      document_url_with_attachments += "/" if !document_url_with_attachments.end_with?("/")
+      document_url_with_attachments += "?attachments=true"
+
+      response = Typhoeus::Request.get(document_url_with_attachments)
+#      puts "Response: #{response.code} #{JSON.parse(response.body).inspect}"
+      json = response.code == 200 ? JSON.parse(response.body) : nil
+
+      error = json.nil? || json["error"]
+
+      # success
+      if error.nil?
+        version = json["_rev"]
+
+        json.delete("_rev")
+        json.delete("_id")
+
+        # make the directory
+        filename = File.basename(outfile)
+        directoryname = File.dirname(outfile)
+        #puts "DIRECTORY: " + directoryname
+        #puts "FILENAME: " + filename 
+        if (directoryname != "")
+          FileUtils.mkdir_p(directoryname)
+        end
+
+        file_existed = File.exists?(outfile + ".json")
+
+        f = open(outfile + ".json", "w")
+        f.write(json.to_json)
+        f.close
+
+        f = open(outfile + ".version", "w")
+        f.write(version)
+        f.close
+
+        say "Created packed document: '#{filename}.json' and version file: '#{filename}.version' in: '#{directoryname}'", :green
+        say "Don't forget to add them as a resource to your project!", :yellow if !file_existed
+
+      # failure
+      else
+        say "couchpack failed: couch responded with: #{json.inspect} for document url: #{document_url}", :red
+      end
+    end
+  end
+  
+end

metadata

@@ -1,27 +1,89 @@
 --- !ruby/object:Gem::Specification 
 name: couchpack
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 21
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
-- Stephane Bellity
 - Kevin Malakoff
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +02:00
+date: 2011-06-19 00:00:00 +02:00
 default_executable: couchpack
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 1
+        - 5
+        version: 1.1.5
+  name: json
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  name: typhoeus
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 0
+        - 14
+        - 0
+        version: 0.14.0
+  name: thor
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  name: couchwatcher
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,11 +93,11 @@ dependencies:
         - 0
         version: "0"
   name: shoulda
-  version_requirements: *id001
+  version_requirements: *id005
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,11 +109,11 @@ dependencies:
         - 0
         version: 1.0.0
   name: bundler
-  version_requirements: *id002
+  version_requirements: *id006
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,11 +125,11 @@ dependencies:
         - 2
         version: 1.5.2
   name: jeweler
-  version_requirements: *id003
+  version_requirements: *id007
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,11 +139,25 @@ dependencies:
         - 0
         version: "0"
   name: rcov
-  version_requirements: *id004
+  version_requirements: *id008
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: yard
+  version_requirements: *id009
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">"
@@ -93,7 +169,68 @@ dependencies:
         - 5
         version: 1.1.5
   name: json
-  version_requirements: *id005
+  version_requirements: *id010
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  name: typhoeus
+  version_requirements: *id011
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 0
+        - 14
+        - 0
+        version: 0.14.0
+  name: thor
+  version_requirements: *id012
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  name: couchwatcher
+  version_requirements: *id013
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: yard
+  version_requirements: *id014
   prerelease: false
 description: Use this gem to pack your couchdb document by stripping out the "_id" and "_rev" fields, and putting the "_rev" in a .version file. To be used with https://github.com/kmalakoff/phonegap-couchbase-xplatform
 email: xmann.intl@gmail.com
@@ -115,6 +252,7 @@ files:
 - bin/couchpack
 - couchpack.gemspec
 - lib/couchpack.rb
+- lib/couchpack/cli.rb
 - test/helper.rb
 - test/test_couchpack.rb
 has_rdoc: true