wsnaps 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efdfcc67158b76a509df614675403e006b5311dc
-  data.tar.gz: 573c00d36967ced954e643f7515861d515a9689a
+  metadata.gz: 95e3846dd8eceef1d11ef189a30b3139360251e9
+  data.tar.gz: 6fad1b153a47fdffef2a39588f9ede3c82e25042
 SHA512:
-  metadata.gz: 3408d81663caa9728efc2c358bac8f7d5b4a6155d3467ee8d14b585b85d30620035d4544198622000768856bbe6f886b7a809a2c985740914b598af956fa6127
-  data.tar.gz: be3ef2b9a1b157328872740627042cea1f70014fb621221c0cbce2944500d4223d79c2881592db57ffedcbc334d956d48a33458b66965770efc0386907bd1eb6
+  metadata.gz: 1f112476a6987fed7d5cab27db1265f6c29afde4c60b7507839c7063a008ed14b2f22202a13e1087437724795095b865c1c509e5a9812e4a1b4cb3b78ccb290d
+  data.tar.gz: 336726c216e84f849c9e04ace43f253751483b854a0d4e30576ced07a329148d46d045ddeb20342022ef0f5af9c850898378b472c970bcbdd140850dc75904ac

data/lib/worksnaps/api/arguments.rb

@@ -0,0 +1,13 @@
+module WorkSnaps
+  module API
+    class Arguments < Array
+      attr_reader :options
+
+      def initialize(args)
+        @options = args.last.is_a?(::Hash) ? args.pop : {}
+        super(args)
+      end
+
+    end
+  end
+end

data/lib/worksnaps/api/projects.rb

@@ -0,0 +1,26 @@
+require 'worksnaps/project'
+require 'worksnaps/api/utils'
+
+module WorkSnaps
+  module API
+    module Projects
+      include WorkSnaps::API::Utils
+
+      def create_project(project_info)
+        object_from_response(WorkSnaps::Project, :post, '/api/projects.xml', {:project => project_info})
+      end
+
+      def update_project(p_id, project_info)
+        object_from_response(WorkSnaps::Project, :put, "/api/projects/#{p_id}.xml", {:project => project_info})
+      end
+
+      def project(p_id)
+        object_from_response(WorkSnaps::Project, :get, "/api/projects/#{p_id}.xml")
+      end
+
+      def projects
+        objects_from_response(WorkSnaps::Project, :get, '/api/projects.xml')
+      end
+    end
+  end
+end

data/lib/worksnaps/api/task_assignments.rb

@@ -0,0 +1,26 @@
+require 'worksnaps/task_assignment'
+require 'worksnaps/api/utils'
+
+module WorkSnaps
+  module API
+    module TaskAssignments
+      include WorkSnaps::API::Utils
+
+      def create_task_assignment(p_id, assignment_info)
+        object_from_response(WorkSnaps::TaskAssignment, :post, "/api/projects/#{p_id}/task_assignments.xml", {:task_assignment => assignment_info})
+      end
+
+      def delete_task_assignment(p_id, assignment_id)
+        object_from_response(WorkSnaps::TaskAssignment, :delete, "/api/projects/#{p_id}/task_assignments/#{assignment_id}.xml")
+      end
+
+      def task_assignment(p_id, assignment_id)
+        object_from_response(WorkSnaps::TaskAssignment, :get, "/api/projects/#{p_id}/task_assignments/#{assignment_id}.xml")
+      end
+
+      def task_assignments(p_id)
+        objects_from_response(WorkSnaps::TaskAssignment, :get, "/api/projects/#{p_id}/task_assignments.xml")
+      end
+    end
+  end
+end

data/lib/worksnaps/api/tasks.rb

@@ -0,0 +1,30 @@
+require 'worksnaps/task'
+require 'worksnaps/api/utils'
+
+module WorkSnaps
+  module API
+    module Tasks
+      include WorkSnaps::API::Utils
+
+      def create_task(p_id, task_info)
+        object_from_response(WorkSnaps::Task, :post, "/api/projects/#{p_id}/tasks.xml", {:task => task_info})
+      end
+
+      def update_task(p_id, t_id, task_info)
+        object_from_response(WorkSnaps::Task, :put, "/api/projects/#{p_id}/tasks/#{t_id}.xml", {:task => task_info})
+      end
+
+      def delete_task(p_id, t_id)
+        object_from_response(WorkSnaps::Task, :delete, "/api/projects/#{p_id}/tasks/#{t_id}.xml")
+      end
+
+      def task(p_id, t_id)
+        object_from_response(WorkSnaps::Task, :get, "/api/projects/#{p_id}/tasks/#{t_id}.xml")
+      end
+
+      def tasks(p_id)
+        objects_from_response(WorkSnaps::Task, :get, "/api/projects/#{p_id}/tasks.xml")
+      end
+    end
+  end
+end

data/lib/worksnaps/api/time_entries.rb

@@ -0,0 +1,30 @@
+require 'worksnaps/time_entry'
+require 'worksnaps/api/utils'
+
+module WorkSnaps
+  module API
+    module TimeEntries
+      include WorkSnaps::API::Utils
+
+      def create_task_assignment(p_id, assignment_info)
+        object_from_response(WorkSnaps::TaskAssignment, :post, "/api/projects/#{p_id}/task_assignments.xml", {:task_assignment => assignment_info})
+      end
+
+      def delete_task_assignment(p_id, assignment_id)
+        object_from_response(WorkSnaps::TaskAssignment, :delete, "/api/projects/#{p_id}/task_assignments/#{assignment_id}.xml")
+      end
+
+      def time_entry(p_id, entry_id)
+        object_from_response(WorkSnaps::TaskAssignment, :get, "/api/projects/#{p_id}/time_entries/#{entry_id}.xml")
+      end
+
+      def screen_short(p_id, entry_id)
+        object_from_response(WorkSnaps::TaskAssignment, :get, "/api/projects/#{p_id}/time_entries/#{entry_id}.xml?full_resolution_url=1")
+      end
+
+      def task_assignments(p_id)
+        objects_from_response(WorkSnaps::TaskAssignment, :get, "/api/projects/#{p_id}/task_assignments.xml")
+      end
+    end
+  end
+end

data/lib/worksnaps/api/user_assignments.rb

@@ -0,0 +1,30 @@
+require 'worksnaps/user_assignment'
+require 'worksnaps/api/utils'
+
+module WorkSnaps
+  module API
+    module UserAssignments
+      include WorkSnaps::API::Utils
+
+      def create_user_assignment(p_id, assignment_info)
+        object_from_response(WorkSnaps::UserAssignment, :post, "/api/projects/#{p_id}/user_assignments.xml", {:user_assignment => assignment_info})
+      end
+
+      def update_user_assignment(p_id, assignment_id, assignment_info)
+        object_from_response(WorkSnaps::UserAssignment, :put, "/api/projects/#{p_id}/user_assignments/#{assignment_id}.xml", {:user_assignment => project_info})
+      end
+
+      def delete_user_assignment(p_id, assignment_id)
+        object_from_response(WorkSnaps::UserAssignment, :delete, "/api/projects/#{p_id}/user_assignments/#{assignment_id}.xml")
+      end
+
+      def user_assignment(p_id, assignment_id)
+        object_from_response(WorkSnaps::UserAssignment, :get, "/api/projects/#{p_id}/user_assignments/#{assignment_id}.xml")
+      end
+
+      def user_assignments(p_id)
+        objects_from_response(WorkSnaps::UserAssignment, :get, "/api/projects/#{p_id}/user_assignments.xml")
+      end
+    end
+  end
+end

data/lib/worksnaps/api/users.rb

@@ -0,0 +1,26 @@
+require 'worksnaps/user'
+require 'worksnaps/api/utils'
+
+module WorkSnaps
+  module API
+    module Users
+      include WorkSnaps::API::Utils
+
+      def create_user(user_info)
+        object_from_response(WorkSnaps::User, :post, '/api/users.xml', {:user => user_info})
+      end
+
+      def update_user(user_id, user_info)
+        object_from_response(WorkSnaps::User, :put, "/api/users/#{user_id}.xml", {:user => user_info})
+      end
+
+      def user(user_id)
+        object_from_response(WorkSnaps::User, :get, "/api/users/#{user_id}.xml")
+      end
+
+      def current_user
+        object_from_response(WorkSnaps::User, :get, '/api/me.xml')
+      end
+    end
+  end
+end

data/lib/worksnaps/api/utils.rb

@@ -0,0 +1,182 @@
+require 'worksnaps/api/arguments'
+
+module WorkSnaps
+  module API
+    module Utils
+
+      DEFAULT_CURSOR = -1
+
+    private
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @return [Object]
+      def object_from_response(klass, request_method, path, options={})
+        response = send(request_method.to_sym, path, options)[:body]
+        klass.fetch_or_new(object_flatten(klass, response))
+      end
+
+      def objects_from_response(klass, request_method, path, options={})
+        response = send(request_method.to_sym, path, options)[:body]
+        objects_array_from_response(klass, response).map {|object_hash|
+          klass.fetch_or_new(object_flatten(klass, object_hash))
+        }
+      end
+
+      def objects_array_from_response(klass, response)
+        objects_hash = response[klass.name.demodulize.tableize]
+        objects_hash ? objects_hash.values : []
+      end
+
+      def object_flatten(klass, attrs = {})
+        attrs ||= {}
+        object = attrs[klass.name.demodulize.underscore] || {}
+        object.symbolize_keys!
+      end
+=begin
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array<WorkSnaps::User>]
+      def threaded_user_objects_from_response(request_method, path, args)
+        arguments = WorkSnaps::API::Arguments.new(args)
+        arguments.flatten.threaded_map do |user|
+          object_from_response(WorkSnaps::User, request_method, path, merge_user(arguments.options, user))
+        end
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array<WorkSnaps::User>]
+      def user_objects_from_response(request_method, path, args)
+        arguments = WorkSnaps::API::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop || screen_name) unless arguments.options[:user_id] || arguments.options[:screen_name]
+        objects_from_response(WorkSnaps::User, request_method, path, arguments.options)
+      end
+
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array]
+      def objects_from_response_with_user(klass, request_method, path, args)
+        arguments = WorkSnaps::API::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop)
+        objects_from_response(klass, request_method, path, arguments.options)
+      end
+
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @return [Array]
+      def objects_from_response(klass, request_method, path, options={})
+        response = send(request_method.to_sym, path, options)[:body]
+        objects_from_array(klass, response)
+      end
+
+      # @param klass [Class]
+      # @param array [Array]
+      # @return [Array]
+      def objects_from_array(klass, array)
+        array.map do |element|
+          klass.fetch_or_new(element)
+        end
+      end
+
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array]
+      def threaded_object_from_response(klass, request_method, path, args)
+        arguments = WorkSnaps::API::Arguments.new(args)
+        arguments.flatten.threaded_map do |id|
+          object_from_response(klass, request_method, path, arguments.options.merge(:id => id))
+        end
+      end
+
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @return [Object]
+      def object_from_response(klass, request_method, path, options={})
+        response = send(request_method.to_sym, path, options)
+        klass.from_response(response)
+      end
+
+      def handle_forbidden_error(klass, error)
+        if error.message == klass::MESSAGE
+          raise klass.new
+        else
+          raise error
+        end
+      end
+
+      def screen_name
+        @screen_name ||= verify_credentials.screen_name
+      end
+
+      # Take a user and merge it into the hash with the correct key
+      #
+      # @param hash [Hash]
+      # @param user [Integer, String, WorkSnaps::User] A WorkSnaps user ID, screen_name, or object.
+      # @return [Hash]
+      def merge_user(hash, user, prefix=nil)
+        merge_user!(hash.dup, user, prefix)
+      end
+
+      # Take a user and merge it into the hash with the correct key
+      #
+      # @param hash [Hash]
+      # @param user [Integer, String, WorkSnaps::User] A WorkSnaps user ID, screen_name, or object.
+      # @return [Hash]
+      def merge_user!(hash, user, prefix=nil)
+        case user
+        when Integer
+          hash[[prefix, "user_id"].compact.join("_").to_sym] = user
+        when String
+          hash[[prefix, "screen_name"].compact.join("_").to_sym] = user
+        when WorkSnaps::User
+          hash[[prefix, "user_id"].compact.join("_").to_sym] = user.id
+        end
+        hash
+      end
+
+      # Take a multiple users and merge them into the hash with the correct keys
+      #
+      # @param hash [Hash]
+      # @param users [Array<Integer, String, WorkSnaps::User>, Set<Integer, String, WorkSnaps::User>] An array of WorkSnaps user IDs, screen_names, or objects.
+      # @return [Hash]
+      def merge_users(hash, users)
+        merge_users!(hash.dup, users)
+      end
+
+      # Take a multiple users and merge them into the hash with the correct keys
+      #
+      # @param hash [Hash]
+      # @param users [Array<Integer, String, WorkSnaps::User>, Set<Integer, String, WorkSnaps::User>] An array of WorkSnaps user IDs, screen_names, or objects.
+      # @return [Hash]
+      def merge_users!(hash, users)
+        user_ids, screen_names = [], []
+        users.flatten.each do |user|
+          case user
+          when Integer
+            user_ids << user
+          when String
+            screen_names << user
+          when WorkSnaps::User
+            user_ids << user.id
+          end
+        end
+        hash[:user_id] = user_ids.join(',') unless user_ids.empty?
+        hash[:screen_name] = screen_names.join(',') unless screen_names.empty?
+        hash
+      end
+=end
+    end
+  end
+end

data/lib/worksnaps/base.rb

@@ -0,0 +1,117 @@
+require 'worksnaps/error/identity_map_key_error'
+
+module WorkSnaps
+  class Base
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    #
+    # @param attrs [Array, Set, Symbol]
+    def self.attr_reader(*attrs)
+      mod = Module.new do
+        attrs.each do |attribute|
+          define_method attribute do
+            @attrs[attribute.to_sym]
+          end
+          define_method "#{attribute}?" do
+            !!@attrs[attribute.to_sym]
+          end
+        end
+      end
+      const_set(:Attributes, mod)
+      include mod
+    end
+
+    # return [WorkSnaps::IdentityMap]
+    def self.identity_map
+      return unless WorkSnaps.identity_map
+      @identity_map = WorkSnaps.identity_map.new unless defined?(@identity_map) && @identity_map.class == WorkSnaps.identity_map
+      @identity_map
+    end
+
+    # Retrieves an object from the identity map.
+    #
+    # @param attrs [Hash]
+    # @return [WorkSnaps::Base]
+    def self.fetch(attrs)
+      return unless identity_map
+      if object = identity_map.fetch(Marshal.dump(attrs))
+        return object
+      end
+      return yield if block_given?
+      raise WorkSnaps::Error::IdentityMapKeyError, "key not found"
+    end
+
+    # Stores an object in the identity map.
+    #
+    # @param object [Object]
+    # @return [WorkSnaps::Base]
+    def self.store(object)
+      return object unless identity_map
+      identity_map.store(Marshal.dump(object.attrs), object)
+    end
+
+    # Retrieves an object from the identity map, or stores it in the
+    # identity map if it doesn't already exist.
+    #
+    # @param attrs [Hash]
+    # @return [WorkSnaps::Base]
+    def self.fetch_or_new(attrs={})
+      return unless attrs
+      return new(attrs) unless identity_map
+
+      fetch(attrs) do
+        object = new(attrs)
+        store(object)
+      end
+    end
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    # @return [WorkSnaps::Base]
+    def initialize(attrs={})
+      @attrs = attrs
+    end
+
+    # Fetches an attribute of an object using hash notation
+    #
+    # @param method [String, Symbol] Message to send to the object
+    def [](method)
+      send(method.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+    # Retrieve the attributes of an object
+    #
+    # @return [Hash]
+    def attrs
+      @attrs
+    end
+    alias to_hash attrs
+
+    # Update the attributes of an object
+    #
+    # @param attrs [Hash]
+    # @return [WorkSnaps::Base]
+    def update(attrs)
+      @attrs.update(attrs)
+      self
+    end
+
+  protected
+
+    # @param attr [Symbol]
+    # @param other [WorkSnaps::Base]
+    # @return [Boolean]
+    def attr_equal(attr, other)
+      self.class == other.class && !other.send(attr).nil? && send(attr) == other.send(attr)
+    end
+
+    # @param other [WorkSnaps::Base]
+    # @return [Boolean]
+    def attrs_equal(other)
+      self.class == other.class && !other.attrs.empty? && attrs == other.attrs
+    end
+
+  end
+end