snapshot-ruby 0.1

data/README.md

@@ -0,0 +1,66 @@
+Snapshot
+========
+
+The Snapshot gem provides an nice, ActiveRecord-ish interface to the
+[Snapshot](http://snapshothq.com/) API.
+
+* [Fork the code on Github](https://github.com/jeremyboles/snapshot-ruby)
+
+Installation
+------------
+
+    gem install snapshot-ruby
+
+Using the gem
+-------------
+
+    require 'rubygems'
+    require 'snapshot'
+
+### Connecting the Client ###
+
+    Snapshot.configure do |config|
+      config.domain = 'yourdomain.snapshothq.com'
+      config.access_key = 'your access key'
+      config.secret_key = 'your secret key'
+    end
+    
+    # or with a hash
+    Snapshot.configure({:access_key => ...})
+    
+### Typical Usage ###
+
+The API for the gem was modeled after ActiveRecord to make it easy to pick up.
+Uploading a video to Snapshot is done with via the `create` method:
+
+    img = Snapshot::Image.create('example.jpg')
+    # => #<Snapshot::Image:0x00000100a51080>
+    
+    img.id
+    # => 'adf4675e46a6078c1bbc6a663a47e1e56e4622e5'
+    
+    img.created_at
+    # => 2011-01-13 15:30:34 -0600
+    
+    img.format
+    # => "JPEG"
+    
+    img.width
+    # => 720
+    
+    img.height
+    # => 640
+    
+Once and image has been uploaded, you can reference and process the image based on its `id`:
+
+    img = Snapshot::Image.find('adf4675e46a6078c1bbc6a663a47e1e56e4622e5')
+    # => #<Snapshot::Image:0x000001008a3df0>
+    
+    img = Snapshot::Image.find('wrong id')
+    # => nil
+    
+To delete an image, call its `destroy` method:
+
+    img.destroy
+    # => true
+    

data/lib/snapshot/connection.rb

@@ -0,0 +1,40 @@
+require 'uri'
+
+module Snapshot
+  class Connection
+    attr_accessor :access_key, :domain, :secret_key
+    
+    # Creates a new Connection object.
+    #
+    # ==== Parameters
+    #
+    # * +opts+ - (optional) String or Hash 
+    #
+    def initialize(opts={})
+      if opts.is_a?(Hash)
+        opts.each do |m,v|
+          self.send("#{m}=", v)
+        end
+      else
+        uri = URI.parse(opts)
+        self.access_key, self.domain, self.secret_key = uri.user, uri.host, uri.password
+        self.domain << ":#{uri.port}" unless uri.port == 80
+      end
+    end
+    
+    # Returns an authenticated RestClient::Resource
+    # 
+    def resource
+      @resource ||= RestClient::Resource.new(self.url, {
+        :user => self.access_key,
+        :password => self.secret_key
+      })
+    end
+    
+    # Returns a URL to Snapshot for the connection
+    #
+    def url
+      "http://#{domain}/"
+    end
+  end
+end

data/lib/snapshot/image.rb

@@ -0,0 +1,115 @@
+require 'json'
+require 'rest_client'
+
+module Snapshot
+  class Image
+    attr_accessor :created_at, :filesize, :format, :height, :id, :width
+    
+    class << self
+      # Uploads a file to the connected Snapshot account. 
+      #
+      # ==== Parameters
+      #
+      # * +file+ - File or path to a file
+      #
+      # ==== Examples
+      #
+      #   # With a path:
+      #   img = Snapshot::Image.create('example.jpg')
+      #
+      #   # With a file:
+      #   file = File.open('example.jpg')
+      #   img = Snapshot::Image.create(file)
+      #
+      def create(file)
+        file = File.open(file) if file.is_a?(String)
+        result = Snapshot.connection.resource.post(:file => file)
+        info = JSON.parse(result)['file']
+        
+        self.new.tap do |img|
+          img.created_at = Time.at(info['uploaded_at'].to_i)
+          img.filesize = info['size'].to_i
+          img.format = info['type']
+          img.height = info['height'].to_i
+          img.id = info['id']
+          img.width = info['width'].to_i
+        end
+      end
+      
+      # Deletes a file from Snapshot.
+      #
+      # ==== Parameters
+      #
+      # * +id+ - The ID of the image
+      #
+      # ==== Examples
+      #
+      #   Snapshot::Image.destroy('a45af9b9e6ebab9c685faef4e72e7a14f3e24e1a')
+      #
+      def destroy(id)
+        find(id).destroy
+      end
+      
+      # Finds a file on the connected Snapshot account.
+      #
+      # ==== Parameters
+      #
+      # * +id+ - The ID of the image 
+      #
+      # ==== Examples
+      #
+      #   Snapshot::Image.find('a45af9b9e6ebab9c685faef4e72e7a14f3e24e1a')
+      #
+      def find(id)
+        result = Snapshot.connection.resource["#{id}"].get
+        info = JSON.parse(result)
+        
+        self.new.tap do |img|
+          img.created_at = Time.at(info['uploaded_at'].to_i)
+          img.filesize = info['size'].to_i
+          img.format = info['type']
+          img.height = info['height'].to_i
+          img.id = info['id']
+          img.width = info['width'].to_i
+        end
+      rescue RestClient::ResourceNotFound
+        nil
+      end
+    end
+
+    # Removes the image from the connect Snapshot account
+    #
+    # ==== Examples
+    #
+    #   img = Snapshot::Image.find('a45af9b9e6ebab9c685faef4e72e7a14f3e24e1a')
+    #   img.destroy
+    #
+    def destroy
+      Snapshot.connection.resource["#{id}"].delete
+      true
+    rescue RestClient::ResourceNotFound
+      nil
+    end
+    
+    # Return the URL of the image
+    #
+    # ==== Examples
+    #
+    #   img = Snapshot::Image.find('a45af9b9e6ebab9c685faef4e72e7a14f3e24e1a')
+    #   img.url # => http://subdomain.snapshothq.com/a45af9b9e6ebab9c685faef4e72e7a14f3e24e1a.jpg
+    #
+    def url(&block)
+      Snapshot::URL.new(id, extension, &block)
+    end
+  
+  private
+  
+    def extension
+      case self.format
+        when 'JPEG' then '.jpg'
+        when 'PNG' then '.png'
+      end
+    end
+    
+  end
+end

data/lib/snapshot/url.rb

@@ -0,0 +1,22 @@
+module Snapshot
+  class URL
+    attr_reader :extension, :id
+    
+    def initialize(id, extension, &block)
+      @id = id
+      @extension = extension
+      @options = []
+      tap(&block) if block_given?
+    end
+    
+    def method_missing(process, *options)
+      @options << [process.to_s, options]
+    end
+    
+    def to_s
+      @options = @options.flatten
+      @options << '' unless @options.empty?
+      Snapshot.connection.url << @options.join('/') << id << '.' << extension
+    end
+  end
+end

data/lib/snapshot/version.rb

@@ -0,0 +1,3 @@
+module Snapshot
+  VERSION = '0.1'
+end

data/lib/snapshot.rb

@@ -0,0 +1,71 @@
+require 'snapshot/connection'
+require 'snapshot/image'
+require 'snapshot/url'
+require 'snapshot/version'
+
+module Snapshot
+  extend self
+  
+  # Configures and connects to Snapshot.
+  #
+  # ==== Parameters
+  #
+  # * +opts+ - String or Hash 
+  # * +block+ - The block is optional and is passed a Connection object
+  #
+  # ==== Examples
+  #
+  #   # Using a String:
+  #   Snapshot.configure('http://access_key:secret_ket@subdomain.snapshothq.com/')
+  #
+  #   # Using a Hash:
+  #   Snapshot.configure(:access_key => 'access_key', :domain => 'subdomain.snapshothq.com', :secret_key => 'secret_key')
+  #
+  #   # Using a block:
+  #   Snapshot.configure do |config|
+  #     config.access_key = 'access_key'
+  #     config.domain = 'subdomain.snapshothq.com'
+  #     config.secret_key = 'secret_key
+  #   end
+  #
+  def configure(opts={})
+    if opts
+      connect!(opts)
+    else
+      yield @connection = Connection.new
+    end
+  end
+  
+  # Connects the library to Snapshot. If no connection options are given, the
+  # method will try to use the environment variable <code>SNAPSHOT_URL</code>.
+  #
+  # ==== Parameters
+  #
+  # * +opts+ - (optional) String or Hash 
+  #
+  # ==== Examples
+  #
+  #   # Using a String:
+  #   Snapshot.connect!('http://access_key:secret_ket@subdomain.snapshothq.com/')
+  #
+  #   # Using a Hash:
+  #   Snapshot.connect!(:access_key => 'access_key', :domain => 'subdomain.snapshothq.com', :secret_key => 'secret_key')
+  #
+  def connect!(opts=nil)
+    opts = ENV['SNAPSHOT_URL'] if opts.nil?
+    @connection = Connection.new(opts)
+  end
+  
+  # Returns the connection for the library. Will raise an error if the
+  # library has not been connected via the <code>connect!</code> method
+  #
+  def connection
+    raise 'Not connected. Please connect! first.' unless @connection
+    @connection
+  end
+  
+  # Terminates the connection to Snapshot
+  def disconnect!
+    @connection = nil
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: snapshot-ruby
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Jeremy Boles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-31 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id004
+description: Snap is a very simple image storage and processing services for developers.
+email: 
+- jeremy@jeremyboles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/snapshot/connection.rb
+- lib/snapshot/image.rb
+- lib/snapshot/url.rb
+- lib/snapshot/version.rb
+- lib/snapshot.rb
+- README.md
+has_rdoc: true
+homepage: https://github.com/jeremyboles/snapshot-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: snapshot-ruby
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for storing and manipulating images via Snapshot.
+test_files: []
+