grabz_it 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,8 @@
 # GrabzIt
 
-TODO: Write a gem description
+Interfaces with the GrabzIt screenshot service (http://grabz.it)
+
+Yard docs can be found at http://www.rubydoc.info/github/cavneb/grabz_it/master/frames
 
 ## Installation
 
@@ -15,10 +17,111 @@ And then execute:
 Or install it yourself as:
 
     $ gem install grabz_it
+    
+## Dependencies
+* [rspec](https://github.com/rspec/rspec) (used in tests only)
 
 ## Usage
 
-TODO: Write usage instructions here
+### Save Picture
+
+Calls the GrabzIt web service to take the screenshot and saves it to the target path provided. 
+
+*Warning, this is a SYNCHONOUS method and can take up to 5 minutes before a response.*
+
+```ruby
+client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+options = {
+  :url            => 'http://grabz.it',
+  :callback_url   => 'http://example.com/callback',
+  :browser_width  => 1024,
+  :browser_height => 768,
+  :output_width   => 800,
+  :output_height  => 600,
+  :custom_id      => '12345',
+  :format         => 'png',
+  :delay          => 1000
+}
+client.save_picture('/tmp/my_picture.png', options)
+
+puts File.exists?('/tmp/my_picture.png')
+# => true
+```
+
+### Take Picture
+
+Calls the GrabzIt web service to take the screenshot. It will optionally ping a callback url with the custom id if provided.
+
+```ruby
+client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+options = {
+  :url            => 'http://grabz.it',
+  :callback_url   => 'http://example.com/callback',
+  :browser_width  => 1024,
+  :browser_height => 768,
+  :output_width   => 800,
+  :output_height  => 600,
+  :custom_id      => '12345',
+  :format         => 'png',
+  :delay          => 1000
+}
+response = client.take_picture('google', options)
+
+puts response.screenshot_id
+# => 'Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58'
+```
+
+### Get Picture
+
+Get the screenshot image
+
+```ruby
+client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+image = client.get_image('Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58')
+
+puts image.content_type
+# => 'image/png'
+puts image.size
+# => 129347
+
+image.save("/tmp/myimage.png")
+File.exist?("/tmp/myimage.png")
+# => true
+```
+
+### Get Status
+
+Get the current status of a GrabzIt screenshot.
+
+```ruby
+client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+status = client.get_status('Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58')
+
+puts status.failed?
+# => false
+puts status.available?
+# => true
+```
+
+### Get Cookie Jar
+
+Get all the cookies that GrabzIt is using for a particular domain. This may include your user set cookies as well.
+
+```ruby
+client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
+cookie_jar = client.get_cookie_jar('google')
+
+puts cookie_jar.cookies.count
+# => 3
+puts cookie_jar.cookies[0].name
+# => 'secure'
+puts cookie_jar.cookies[0].domain
+# => 'accounts.google.com'
+```
+
+## TODO
+
+* Create the ability to set and delete cookies.
 
 ## Contributing
 

data/lib/grabz_it/client.rb

@@ -20,8 +20,8 @@ module GrabzIt
     end
 
     ##
-    # Calls the GrabzIt web service to take the screenshot. Warning, this is a SYNCHONOUS method and can take up to
-    # 5 minutes before a response.
+    # Calls the GrabzIt web service to take the screenshot and saves it to the target path provided. Warning, this is a 
+    # SYNCHONOUS method and can take up to 5 minutes before a response.
     #
     # @param [String] target_path File path that the file should be saved to (including file name and extension)
     # @param [Hash] options Data that is to be passed to the web service
@@ -50,7 +50,7 @@ module GrabzIt
     #     :format         => 'png',
     #     :delay          => 1000
     #   }
-    #   response = client.take_picture(options)
+    #   response = client.save_picture('google', options)
     #
     def save_picture(target_path, options = {})
       response = take_picture(options)
@@ -140,17 +140,17 @@ module GrabzIt
     end
 
     ##
-    # Get the current status of a GrabzIt screenshot.
+    # Get all the cookies that GrabzIt is using for a particular domain. This may include your user set cookies as well.
     #
-    # @param [String] screenshot_id The id of the screenshot provided by the GrabzIt api
+    # @param [String] domain The domain of the cookie
     # 
-    # @return [GrabzIt::Status] The parsed status.
+    # @return [GrabzIt::CookieJar] The container that holds the cookies
     #
     # @example
     #   client = GrabzIt::Client.new('TEST_KEY', 'TEST_SECRET')
-    #   status = client.get_status('Y2F2bmViQGdtYWlsLmNvbQ==-20943258e37c4fc28c4977cd76c40f58')
+    #   cookie_jar = client.get_cookie_jar('google')
     #
-    def get_cookies(domain)
+    def get_cookie_jar(domain)
       action = "getcookies.ashx"
       sig = Digest::MD5.hexdigest(@app_secret + "|" + domain)
       params = {
@@ -164,6 +164,18 @@ module GrabzIt
       cookie_jar
     end
 
+    ##
+    # Pending API documentation
+    #
+    # def set_cookie(options = {})
+    # end
+
+    ##
+    # Pending API documentation
+    #
+    # def delete_cookie(name, domain)
+    # end
+
     ##
     # Get the screenshot image
     #
@@ -193,6 +205,7 @@ module GrabzIt
 
     # Helper method that performs the request
     def query_api(action, params)
+      params = params.symbolize_keys
       uri = URI("#{API_BASE_URL}#{action}")
       uri.query = URI.encode_www_form(params)
       res = Net::HTTP.get_response(uri)

data/lib/grabz_it/cookie.rb

@@ -1,5 +1,41 @@
 module GrabzIt
   class Cookie
     attr_accessor :name, :value, :domain, :path, :http_only, :expires, :type
+
+    # def initialize(options = {})
+    #   options = options.symbolize_keys
+    #   @domain    = options[:domain]
+    #   @name      = options[:name]
+    #   @value     = options[:value]
+    #   @path      = options[:path]
+    #   @http_only = options[:http_only]
+    #   @expires   = options[:expires]
+    # end
+
+    # def params_for_set_request
+    #   {
+    #     :domain    => URI.escape(@domain)  || '',
+    #     :name      => URI.escape(@name)    || '',
+    #     :value     => URI.escape(@value)   || '',
+    #     :path      => URI.escape(@path)    || '',
+    #     :http_only => @http_only ? 1 : 0, 
+    #     :expires   => URI.escape(@expires) || ''
+    #   }
+    # end
+
+    # def generate_signature(app_key)
+    #   parts = []
+    #   parts << app_key
+    #   parts << @name
+    #   parts << @domain
+    #   parts << @value
+    #   parts << @path
+    #   parts << @http_only ? 1 : 0
+    #   parts << @expires
+    #   parts << 0
+    #   unencoded_sig = parts.join('|')
+    #   puts "SIG: #{unencoded_sig}"
+    #   sig = Digest::MD5.hexdigest(unencoded_sig)
+    # end
   end
 end

data/lib/grabz_it/version.rb

@@ -1,3 +1,3 @@
 module GrabzIt
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/client_spec.rb

@@ -127,7 +127,7 @@ describe GrabzIt::Client do
     ## ------------------------------------------------------------------------------------
     # Get Cookies
     ## ------------------------------------------------------------------------------------
-    describe "#get_cookies" do
+    describe "#get_cookie_jar" do
       it "with valid domain" do
         xml = <<-EOF
           <?xml version="1.0"?>
@@ -164,7 +164,7 @@ describe GrabzIt::Client do
           </WebResult>
         EOF
         @client.stub!(:query_api).and_return(xml)
-        cookie_jar = @client.get_cookies('google')
+        cookie_jar = @client.get_cookie_jar('google')
         cookie_jar.cookies.size.should eq(3)
         cookie_jar.cookies[0].name.should eq('secure')
         cookie_jar.cookies[0].domain.should eq('accounts.google.com')
@@ -179,7 +179,7 @@ describe GrabzIt::Client do
           </WebResult>
         EOF
         @client.stub!(:query_api).and_return(xml)
-        cookie_jar = @client.get_cookies('fsoi')
+        cookie_jar = @client.get_cookie_jar('fsoi')
         cookie_jar.cookies.should be_empty
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grabz_it
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: