chute 0.0.2

data/lib/chute/parcel.rb

@@ -0,0 +1,45 @@
+module Chute
+  class GCParcel < GCResource
+    attr_accessor :id,
+                  :status,
+                  :share_url,
+                  :device_id,
+                  :asset_count
+    
+    def initialize(attributes = {})
+      super
+      @id          = attributes[:id]
+      @status      = attributes[:status]
+      @share_url   = attributes[:share_url]
+      @device_id   = attributes[:device_id]
+      @asset_count = attributes[:asset_count]
+    end
+    
+    # Public: Returns pluralized name of the resource.
+    def resource_name
+      "parcels"
+    end
+    
+    # Public: Returns pluralized name of the resource.
+    def class_path
+      "parcels"
+    end
+    
+    # Public: Fetch parcel from its id.
+    # id - Integer: identifier.
+    #
+    # Example
+    #
+    #   Chute::GCParcel.find_by_id(23)     
+    #   # => parcel
+    #   # => false if not found
+    # Returns GCParcel
+    
+    def self.find_by_id(id)
+      parcel = Chute::GCParcel.new
+      parcel.perform(get("/parcels/#{id}"))
+      parcel
+    end
+
+  end
+end

data/lib/chute/resource.rb

@@ -0,0 +1,354 @@
+module Chute
+  class GCResource
+    attr_accessor :attributes, :errors, :meta, :prefix_options
+    
+    def initialize(attributes = {})
+      @errors         = []
+      @attributes     = attributes
+      @prefix_options = {}
+    end
+    
+    # Public: Save the resource instance
+    #
+    # Examples
+    #
+    #   chute = GCChute.new(:name => "Test Chute")
+    #   # => GCChute instance
+    # 
+    #   For valid sttributes
+    #     chute.save
+    #     # => true
+    #     chute.id
+    #     # => 23
+    #   For invalid attributes
+    #     chute.save
+    #     # => false
+    #     chute.id
+    #     # => nil
+    #     chute.errors
+    #     # => {"name already taken"}
+    def save
+      options = {}
+      options["#{resource_name.singularize}"] = attributes
+      options.merge!(prefix_options)
+      perform(self.class.post("/#{resource_name}", options))
+    end
+    
+    # Public: Update the resource instance
+    #
+    # Examples
+    #
+    #   chute = GCChute.new(:name => "Test Chute")
+    #   # => GCChute instance
+    #   chute.save
+    #   # => true
+    #   chute.name = "Name Changed"
+    #   chute.update
+    #   # => true
+    #   Return errors in case the request failed
+    
+    def update
+      options = {}
+      options["#{resource_name.singularize}"] = attributes
+      options.merge!(prefix_options)
+      perform(self.class.put("/#{resource_name}/#{id}", options))
+    end
+    
+    # Public: Delete a resource instance
+    #
+    # Examples
+    #
+    #   chute = GCChute.new(:name => "Test Chute")
+    #   # => GCChute instance
+    #   chute.save
+    #   # => true
+    #   chute.destroy
+    #   # => true
+    #   Return false in case the request failed or chute not found
+    
+    def destroy
+      response = self.class.delete("/#{resource_name}/#{id}", prefix_options)
+      response.is_success
+    end
+    
+    # Public: Pluralized name of the resource.
+    def resource_name
+      raise NotImplementedError
+    end
+    
+    # Public: Relative path to the resource path.
+    def resource_path
+      "#{resource_name}/#{id}"
+    end
+    
+    # Public: Returns if the resource is valid.
+    def valid?
+      errors.size == 0
+    end
+    
+    # Public: Returns if the resource is new.
+    def new?
+      !self.id.blank?
+    end
+    
+    # Public: Fetch collection of resources.
+    # Implemented in the inherited classes.
+    
+    def self.all
+      raise NotImplementedError
+    end
+    
+    # Public: Fetch resource from its id.
+    # Implemented in the inherited classes.
+    # id - Identifier.
+    
+    def self.find_by_id(id)
+      raise NotImplementedError
+    end
+    
+    # Public: Search all chutes with specified key.
+    #
+    # key   - key to be searched.
+    # value - Optional, value of the key.
+    # 
+    # Example
+    #
+    #   Chute::GCChute.search("title")
+    #   # => GCollection of the chutes with a key "title" in meta data
+    #
+    #   Chute::GCChute.search("title", "Testing")
+    #   # => GCollection of the chutes with a key "title" and its value "Testing" in meta data
+    
+    def self.search(key, value=nil)
+      self.perform(get("/#{class_path}/meta/#{key}/#{value}"))
+    end
+    
+    # Public: Set meta data for one or more keys for the resource.
+    #
+    # data  - Hash or String.
+    #         Hash of key/value pair to be added to the meta data.
+    #         String value for a key specified as the next parameter.
+    #
+    # key   - Optional. String if a specific key value to be set.
+    #
+    # Examples
+    #
+    #   chute = GCChute.find_by_id(23)  
+    #   # => GCChute instance
+    # 
+    #   For a key.
+    #     chute.set_meta_data("Testing", :title)
+    #     # => true
+    #     chute.get_meta_data(:title)
+    #     # => "Testing"
+    #
+    #   Add a Hash to meta data.
+    #     chute.set_meta_data({:details => "Testing the methods", :source => "Mobile"})
+    #     # => true
+    #     chute.get_meta_data
+    #     # => {:title => "Testing", :details => "Testing the methods", :source => "Mobile"}
+    
+    def set_meta_data(data, key=nil)
+      response = (key.blank? and Hash === data) ? (self.class.post("/#{resource_path}/meta", data.to_json)) : (self.class.post("/#{resource_path}/meta/#{key}", data))
+      if response.is_success
+        Hash === data ? (self.meta = data) : (self.meta[key]  = data)
+        true
+      else
+        false
+      end
+    end
+    
+    # Public: Get complete meta data or a specific key for the resource.
+    #
+    # key - Optional. String if a specific key value to be fetched.
+    #
+    # Examples
+    #
+    #   chute = GCChute.find_by_id(23)  
+    #   # => GCChute instance
+    # 
+    #   With a key.
+    #     chute.get_meta_data(:title)
+    #     # => "Testing"
+    #
+    # Returns String value of meta data for a key
+    #
+    #   Without a key.
+    #     chute.get_meta_data
+    #     # => {:title => "Testing", :source => "Mobile"}
+    # 
+    # Returns meta data Hash without a key
+    
+    def get_meta_data(key=nil)
+      if key.blank?
+        response  = self.class.get("/#{resource_path}/meta")
+      else
+        response  = self.class.get("/#{resource_path}/meta/#{key}")
+      end
+      if response.is_success
+        Hash === response.data ? (self.meta = response.data) : (self.meta[key]  = response.data)
+      else
+        false
+      end
+    end
+    
+    # Public: Deletes complete meta data or a specific key for the resource.
+    #
+    # key - Optional. String if a specific key to be deleted.
+    #
+    # Examples
+    #
+    #   chute = GCChute.find_by_id(23)  
+    #   # => GCChute instance
+    #
+    #   chute.get_meta_data 
+    #   # => {:title => "Testing", :source => "Mobile"}
+    # 
+    #   With a key.
+    #     chute.delete_meta_data(:title)
+    #     # => "Testing"
+    #     chute.get_meta_data
+    #     # => {:source => "Mobile"}
+    #
+    #   Without a key.
+    #     chute.delete_meta_data
+    #     # => {}
+    #     chute.get_meta_data
+    #     # => {}
+    
+    def delete_meta_data(key = nil)
+      if key.blank?
+        response = self.class.delete("/#{resource_path}/meta")
+        response.is_success ? self.meta = {} : false
+      else
+        response = self.class.delete("/#{resource_path}/meta/#{key}")
+        response.is_success ? self.meta.delete(key) : false
+      end
+    end
+    
+    # Protected: Handles GCResponse object and updates chute instance with the updated values
+    # 
+    # response - GCResponse object
+    #
+    # Returns a resource instance
+    def perform(response)
+      if response.is_success
+        response.data.each do |key, value|
+          attributes[key.to_sym] = response.data[key] if (self.instance_variable_defined?("@#{key}") rescue nil)
+        end
+        return true
+      else
+        self.errors = response.errors
+        return false
+      end
+    end
+    
+    # Protected: Handles GCResponse object.
+    # 
+    # response - GCResponse object
+    #
+    # Returns a collection of the resources
+
+    def self.perform(response)
+      collection = Chute::GCCollection.new
+      if response.is_success
+        data = Hash === response.data ? response.data["#{class_path}"] : response.data
+        data = [] unless (data and !data.empty?)
+        data.each do |item|
+          new_resource = self.new
+          item.each do |key, value|
+            new_resource.attributes[key.to_sym] = value if (new_resource.instance_variable_defined?("@#{key}") rescue nil)
+          end
+          collection << new_resource
+        end
+        return collection
+      else
+        debugger
+        raise Chute::Exceptions::InValidResponse, response.errors
+      end
+    end
+    
+    protected
+    
+      # Protected: Overriding attr_accessor.
+      # It keeps attributes hash in sync with class attributes.
+
+      class << self
+        def attr_accessor(*names)
+          super
+          unless name.match(/^x_/)
+            names.each do |name|
+              self.class_eval do
+                define_method name do
+                  attributes[name]
+                end
+
+                define_method("#{name}=") do |value|
+                  attributes[name] = value
+                end
+              end
+            end
+          end
+        end
+      end
+
+      # Protected: Custom get request to a specific URL. 
+      #
+      # url     - relative url.
+      # params  - parameters hash.
+      # headers - headers hash.
+      #
+      # Returns a GCResponse.
+
+      def self.get(url, params=nil, headers=nil)
+        @request = GCRequest.new()
+        @request.get(url, params)
+      end
+
+      # Protected: Custom post request to a specific URL. 
+      #
+      # url     - relative url.
+      # params  - parameters hash.
+      # headers - headers hash.
+      #
+      # Returns a GCResponse.
+
+      def self.post(url, params=nil, headers=nil)
+        @request = GCRequest.new()
+        @request.post(url, params)
+      end
+
+      # Protected: Custom put request to a specific URL. 
+      #
+      # url     - relative url.
+      # params  - parameters hash.
+      # headers - headers hash.
+      #
+      # Returns a GCResponse.
+
+      def self.put(url, params=nil, headers=nil)
+        @request = GCRequest.new()
+        @request.put(url, params)
+      end
+
+      # Protected: Custom delete request to a specific URL. 
+      #
+      # url     - relative url.
+      # params  - parameters hash.
+      # headers - headers hash.
+      #
+      # Returns a GCResponse.
+
+      def self.delete(url, params=nil, headers=nil)
+        @request = GCRequest.new()
+        @request.delete(url, params)
+      end
+      
+      # Protected: Set whether the resource has meta data or not
+
+      def has_meta?
+        true
+      end
+    
+  end
+end

data/lib/chute/user.rb

@@ -0,0 +1,113 @@
+module Chute
+  class GCUser < GCResource
+    attr_accessor :id,
+                  :name,
+                  :email,
+                  :login,
+                  :avatar,
+                  :notification_photos,
+                  :notification_comments,
+                  :notification_invites
+
+    def initialize(attributes = {})
+      super
+      @id                     = attributes[:id]
+      @name                   = attributes[:name]
+      @email                  = attributes[:email]
+      @login                  = attributes[:login]
+      @notification_photos    = attributes[:notification_photos]
+      @notification_invites   = attributes[:notification_invites]
+      @notification_comments  = attributes[:notification_comments]
+    end
+    
+    # Public: Returns pluralized name of the resource.
+    def resource_name
+      "me"
+    end
+    
+    # Public: Returns resource path.
+    def resource_path
+      "#{resource_name}"
+    end
+    
+    # Public: Collection of accounts associated with user.
+    #
+    # Returns GCCollection of GCAccount.
+    def accounts
+      Chute::GCAccount.perform(self.class.get("/#{id}/accounts"))
+    end
+    
+    # Public: Collection of assets associated with user.
+    #
+    # Returns GCCollection of GCAsset.
+    def assets
+      Chute::GCAsset.perform(self.class.get("/#{id}/assets"))
+    end
+    
+    # Public: Collection of bundles associated with user.
+    #
+    # Returns GCCollection of GCBundle.
+    def bundles
+      Chute::GCBundle.perform(self.class.get("/#{id}/bundles"))
+    end
+    
+    # Public: Collection of chutes associated with user.
+    #
+    # Returns GCCollection of GCChute.
+    def chutes
+      Chute::GCChute.perform(self.class.get("/#{id}/chutes"))
+    end
+    
+    # Public: Collection of parcels associated with user.
+    #
+    # Returns GCCollection of GCParcel.
+    def parcels
+      Chute::GCParcel.perform(self.class.get("/#{id}/parcels"))
+    end
+    
+    # Public: Collection of favorite assets associated with user.
+    #
+    # Returns GCCollection of GCChute.
+    def hearts
+      Chute::GCChute.perform(self.class.get("/#{id}/hearts"))
+    end
+    
+    #below collections aren't working yet, there classes still ned to be implemented.
+    def devices
+      Chute::GCAsset.perform(self.class.get("/#{id}/devices"))
+    end
+    
+    def notices
+      Chute::GCAsset.perform(self.class.get("/#{id}/notices"))
+    end
+    
+    
+    # Public: Generate single use token for logging into Chute.
+    # 
+    # Returns single use token String.
+    def single_use_token
+      response = self.class.get("/oauth/single_use_token", nil, {'X_USER_IDENTIFIER' => id})
+      response.data
+    end
+    
+    # Public: Returns pluralized name of the resource.
+    def class_path
+      "me"
+    end
+    
+    # Public: Fetch user from the API key.
+    #
+    # Example
+    #
+    #   Chute::GCUser.me
+    #   # => user
+    #   # => false if not found
+    # Returns GCUser.
+    
+    def self.me
+      user = Chute::GCUser.new
+      user.perform(get("/info")) ? user : false
+    end 
+    
+  end
+end