chute 0.0.2

data/lib/chute/chute.rb

@@ -0,0 +1,203 @@
+module Chute
+  class GCChute < GCResource
+    
+    CHUTE_STATUS =  {
+                      "401" => "Password Protected",
+                      "200" => "Public"
+                    }
+    
+    attr_accessor :id,
+                  :name,
+                  :shortcut,
+                  :created_at,
+                  :updated_at,
+                  :assets_count,
+                  :members_count,
+                  :contributors_count,
+                  :moderate_photos,
+                  :moderate_members,
+                  :moderate_comments,
+                  :permission_view, 
+                  :permission_add_photos,
+                  :permission_add_members,
+                  :permission_add_comments
+    
+    def initialize(attributes = {})
+      super
+      @id                       = attributes[:id]
+      @name                     = attributes[:name]
+      @shortcut                 = attributes[:shortcut]
+      
+      @created_at               = attributes[:created_at]
+      @updated_at               = attributes[:updated_at]
+      
+      @assets_count             = attributes[:assets_count]
+      @members_count            = attributes[:members_count]
+      @contributors_count       = attributes[:contributors_count]
+      
+      @moderate_photos          = attributes[:moderate_photos]
+      @moderate_members         = attributes[:moderate_members]
+      @moderate_comments        = attributes[:moderate_comments]
+      
+      @permission_view          = attributes[:permission_view]
+      @permission_add_photos    = attributes[:permission_add_photos]
+      @permission_add_members   = attributes[:permission_add_members]
+      @permission_add_comments  = attributes[:permission_add_comments]
+    end
+    
+    # Public: Fetch child chutes for a chute
+    #
+    # Returns GCCollection of GCChute
+    
+    def children
+      self.class.perform(self.class.get("/chutes/#{id}/children"))
+    end
+    
+    # Public: Send a join request for a chute.
+    #
+    # Password - String, required for password protected chutes.
+    # 
+    # Returns membership details and status.
+    #   Public Chute - Request accepted.
+    #   Password-protected Chute - Password required.
+    #   Private Chute - Request for approval sent to admin.
+    
+    def join(password=nil)
+      response = self.class.get("/chutes/#{id}/join")
+      response.data
+    end
+    
+    # Public: Leave a chute.
+    def leave
+      response = self.class.post("/chutes/#{id}/leave")
+      response.data
+    end
+    
+    # Public: Fetch list of chute contributors.
+    def contributors
+      Chute::GCChute.perform(self.class.post("/chutes/#{id}/contributors"))
+    end
+    
+    # Public: Fetch assets for a chute
+    #
+    # Returns GCCollection of GCAsset
+    def assets
+      Chute::GCAsset.perform(self.class.get("/chutes/#{id}/assets"))
+    end
+    
+    # def add_assets(asset_ids)
+    #   response = self.class.post("/chutes/#{id}/add_assets", :asset_ids => "#{asset_ids}")
+    #   response.is_success
+    # end
+    
+    # Public: Remove assets from a chute
+    #
+    # Example
+    #
+    #   Chute::GCChute.remove_assets([1, 23, 56])     
+    #   # => true
+    #
+    # Returns boolean true or false
+    def remove_assets(asset_ids)
+      response = self.class.post("/chutes/#{id}/assets/remove", :asset_ids => asset_ids)
+      response.is_success
+    end
+    
+    # Public: Comment on an asset in a chute
+    #
+    # text      - String, comment
+    # asset_id  - Identifier of the asset
+    #
+    # Example
+    #
+    #   Chute::GCChute.add_comment("Nice Picture", 24)     
+    #   # => comment
+    #
+    # Returns GCComment instance
+    def add_comment(text, asset_id)
+      comment = Chute::GCComment.new
+      comment.perform(self.class.post("/chutes/#{id}/assets/#{asset_id}/comments", {:comment => "test comment by payal"}))
+      comment
+    end
+    
+    # Public: Fetch comments for a asset
+    #
+    # asset_id - Identifier for asset
+    #
+    # Returns GCCollection of GCAsset
+    def comments(asset_id)
+      Chute::GCComment.perform(self.class.get("/chutes/#{id}/assets/#{asset_id}/comments"))
+    end
+    
+    # Public: Returns pluralized name of the resource.
+    def resource_name
+      'chutes'
+    end
+    
+    # Public: Fetch chute status from its shortcut.
+    # shortcut - String: shortcut of the chute.
+    #
+    # Example
+    #
+    #   Chute::GCChute.fetch_status("adsvyh")     
+    #   # => public, password-protected or inaccessible
+    # Returns public, password-protected or inaccessibles string
+    
+    def self.fetch_status(shortcut)
+      chute     = Chute::GCChute.new
+      response  = get("/chutes/#{shortcut}/public/assets.js")
+      CHUTE_STATUS[response.status] || "InAccessible"
+    end
+    
+    # Public: Fetch chute from its shortcut.
+    # shortcut - String: shortcut of the chute.
+    #
+    # Example
+    #
+    #   Chute::GCChute.find_by_shortcut("adsvyh")     
+    #   # => chute
+    #   # => false if not found
+    # Returns GCChute.
+    
+    def self.find_by_shortcut(shortcut)
+      chute = Chute::GCChute.new
+      chute.perform(get("/chutes/#{shortcut}"))
+    end
+    
+    # Public: Fetch chute from its id.
+    # id - Integer: identifier.
+    #
+    # Example
+    #
+    #   Chute::GCChute.find_by_id(23)     
+    #   # => chute
+    #   # => false if not found
+    # Returns GCChute.
+    
+    def self.find_by_id(id)
+      chute = Chute::GCChute.new
+      chute.perform(get("/chutes/#{id}")) ? chute : false
+    end
+    
+    # Public: Fetch all chutes for the user.
+    #
+    # Returns GCCollection of GCChutes.
+    def self.all
+      self.perform(get("/me/chutes"))
+    end
+    
+    # Public: Fetch chute heirarchy for the user
+    #
+    # Returns GCCollection of GCChute
+    
+    def self.tree
+      perform(get("/chutes/tree"))
+    end
+    
+    # Public: Returns pluralized name of the resource.
+    def self.class_path
+      "chutes"
+    end
+    
+  end
+end

data/lib/chute/collection.rb

@@ -0,0 +1,47 @@
+module Chute
+  class GCCollection < Array
+    
+    # Public: Append an item to collection
+    # single_or_array - Single item or an Array of item
+    #
+    # Example
+    #
+    #   gc_collection = Chute::GCChute.all
+    #   chute         = Chute.new(:name => "New Chute Added")
+    #   chute.save
+    #
+    #   gc_collection.append(chute)     
+    #   # => appends the chute to the colection
+    # Returns GCCollection.
+    
+    def append(single_or_array)
+      if Array === single_or_array
+        self.concat(single_or_array)
+      else
+        self << single_or_array
+      end
+      self.uniq!
+    end
+    
+    # Public: Remove an item to collection
+    # single_or_array - Single item or an Array of item
+    #
+    # Example
+    #
+    #   gc_collection = Chute::GCChute.all
+    #   chute         = Chute.find_by_id(23)
+    #
+    #   gc_collection.remove(chute)     
+    #   # => remove the chute from the colection
+    # Returns GCCollection.
+    
+    def remove(single_or_array)
+      if Array === single_or_array
+        self.reject!{|elem| single_or_array.include?(elem)}
+      else
+        self.delete(single_or_array)
+      end
+      self.uniq!
+    end
+  end
+end

data/lib/chute/comment.rb

@@ -0,0 +1,32 @@
+module Chute
+  class GCComment < GCResource
+    attr_accessor :id,
+                  :status,
+                  :comment
+    
+    def initialize(attributes = {})
+      super
+      @id             = id
+      @status         = status
+      @comment        = comment
+    end
+    
+    # Public: Returns pluralized name of the resource.
+    def resource_name
+      "comments"
+    end
+    
+    def save
+      raise NotImplementedError
+    end
+    
+    def update
+      raise NotImplementedError
+    end
+    
+    # Public: Returns pluralized name of the resource.
+    def class_path
+      "comments"
+    end
+  end
+end

data/lib/chute/exception.rb

@@ -0,0 +1,7 @@
+# lib/exceptions.rb
+module Chute
+  module Exceptions
+    class UnAuthorized < StandardError; end
+    class InValidResponse < StandardError; end
+  end
+end

data/lib/chute/http_service.rb

@@ -0,0 +1,114 @@
+module Chute
+  class GCRequest
+    include HTTParty
+    
+    HEADERS = {"authorization" => API_KEY}
+  
+    base_uri  API_URL
+
+    # Public: Get request to a specific URL. 
+    #
+    # url     - relative url.
+    # params  - parameters hash.
+    # headers - headers hash.
+    #
+    # Returns a GCResponse.
+    
+    def get(url, params=nil, header_options=nil) 
+      GCResponse.new(GCRequest.get(url, {:body => params, :headers => get_headers(header_options)}))
+    end
+    
+    # Public: Post request to a specific URL. 
+    #
+    # url     - relative url.
+    # params  - parameters hash.
+    # headers - headers hash.
+    #
+    # Returns a GCResponse.
+    
+    def post(url, params=nil, header_options=nil)
+      GCResponse.new(GCRequest.post(url, {:body => params, :headers => get_headers(header_options)}))
+    end
+    
+    # Public: Put request to a specific URL. 
+    #
+    # url     - relative url.
+    # params  - parameters hash.
+    # headers - headers hash.
+    #
+    # Returns a GCResponse.
+    
+    def put(url, params=nil, header_options=nil)
+      GCResponse.new(GCRequest.put(url, {:body => params, :headers => get_headers(header_options)}))
+    end
+    
+    # Public: Delete request to a specific URL. 
+    #
+    # url     - relative url.
+    # params  - parameters hash.
+    # headers - headers hash.
+    #
+    # Returns a GCResponse.
+    
+    def delete(url, params=nil, header_options=nil)
+      GCResponse.new(GCRequest.delete(url, {:body => params, :headers => get_headers(header_options)}))
+    end
+    
+    protected
+    
+      # Protected: Add custom headers to default header options.
+      #
+      # header_options - Hash, header options.
+      #
+      # Returns final header Hash
+    
+      def get_headers(header_options)
+        Hash === header_options ? header_options.merge(HEADERS) : HEADERS
+      end
+
+  end
+
+  class GCResponse
+    attr_reader :raw_response, :data, :errors, :status, :is_success
+    def initialize(attributes = {})
+      @raw_response     = attributes
+      @status           = attributes.response.code
+      @errors           = []
+      parse(attributes.parsed_response)
+    end
+    
+    protected
+    
+      # Protected: Parse the data from the response
+      #
+      # parsed_response - HTTParty parsed response
+      #
+      # In case, 
+      #   status code is,
+      #     < 300 - successful, set GCResponse.data as the returned data
+      #     401   - failed, Raise UnAuthorized Exception (like API key invalid or missing)
+      #     other - failed, set GCResponse.errors as the returned errors
+      #     
+      # Returns a GCResponse.
+    
+      def parse(parsed_response)
+        if status.to_i <= 300
+          if parsed_response["errors"]
+            @is_success = false
+            parsed_response["errors"].each do |error|
+              @errors << error
+            end
+          else
+            @is_success = true
+            @data       = parsed_response["data"]
+          end
+        else
+          @is_success = false
+          @errors << parsed_response["error"]
+          if status == "401"
+            raise Chute::Exceptions::UnAuthorized, parsed_response["error"]
+          end
+        end
+      end
+  end
+end

data/lib/chute/inbox.rb

@@ -0,0 +1,41 @@
+module Chute
+  class GCInbox
+    
+    # Public: Fetch inbox information.
+    #
+    # Returns photo, comments, requests and invite count.
+    def self.info
+      request   = GCRequest.new()
+      response  = request.get("/#{class_path}")
+      response.data
+    end
+    
+    # Public: Fetch list of invitations.
+    def self.invitations
+      request   = GCRequest.new()
+      response  = request.get("/#{class_path}/invites")
+      response.data
+    end
+    
+    # Public: Fetch list of parcels.
+    def self.parcels
+      request   = GCRequest.new()
+      Chute::GCParcel.perform(request.get("/#{class_path}/parcels"))
+    end
+    
+    # Public: Fetch specific parcel data.
+    # parcel_id - String, Identifier for parcel
+    def self.parcel(parcel_id)
+      request = GCRequest.new()
+      parcel  = Chute::GCParcel.new
+      parcel.perform(request.get("/#{class_path}/parcels/#{parcel_id}"))
+      parcel
+    end
+    
+    # Public: Resource Name
+    def self.class_path
+      'inbox'
+    end
+    
+  end
+end