hookercookerman-amee 0.1.9 → 0.2.0

data/Manifest.txt

@@ -3,7 +3,6 @@ LICENSE.txt
 Manifest.txt
 README.rdoc
 Rakefile
-amee.gemspec.old
 features/config.feature
 features/data/data_category.feature
 features/data/data_item.feature

data/amee.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee}
-  s.version = '0.1.9'
+  s.version = '0.2.0'
   
   s.homepage = 'http://github.com/hookercookerman/amee/tree/master'
   s.description = %q{Its a gem to interact with the amee api}

data/features/profile/create.profile.feature

@@ -1,13 +1,18 @@
 Feature: Creating a Profile
   In order to keep a container for an object | user for calculating co2 emissions
   As a amee developer
-  I want to be alble to create a profile
+  I want to be able to create a profile
   
   
   Scenario: Create a amee profile
     Given I have a valid amee session
     When I create an amee profile
     Then I should have a valid amee profile
+    
+  
+  Scenario: Create a amee profile with representation none
+    Given I have a valid amee session
+    When I create an amee profile with representation false
   
   
   

data/features/step_definitions/profile_item_steps.rb

@@ -22,7 +22,7 @@ When(/^I create a profile item with data_item_uid: \"(\S+)\" the path: \"(.*)\"/
   FakeWeb.register_uri(:post, "http://stage.amee.com#{path}?kWhPerMonth=10&dataItemUid=66056991EE23&representation=full",
   :file => File.join(AMEE_FIXTURE_PATH, "/profiles/BB1BDB4FDD77/home/energy/quantity/response.json")
    )
-  @models["profile_category"] = @amee_session.create_profile_item(path, uid, :fields => {:kWhPerMonth => "10"})
+  @models["profile_category"] = @amee_session.create_profile_item(path, uid, :representation => true, :query => {:kWhPerMonth => "10"})
 end
 
 When(/^I update the profile item with: distance=400$/) do

data/features/step_definitions/profile_steps.rb

@@ -5,6 +5,13 @@ When(/^I create an amee profile$/) do
   @models["profile"] = @amee_session.create_profile
 end
 
+When(/^I create an amee profile with representation false$/) do
+  FakeWeb.register_uri(:post, "http://stage.amee.com/profiles?profile=true", 
+    :file => File.join(AMEE_FIXTURE_PATH, "profiles/profile.json")
+   )
+  @models["profile"] = @amee_session.create_profile
+end
+
 Then(/^I should have a valid amee profile$/) do
   @models["profile"].name.should == "180D73DA5229"
   @models["profile"].uid.should == "180D73DA5229"

data/lib/amee/data_api/data_category.rb

@@ -10,8 +10,10 @@ module Amee
                       :data_items => {:class => Amee::DataApi::DataItem}
       item_populators :item_definition => {:class => Amee::DataApi::ItemDefinition}
       
-      # essentially the parent category                
-      attr_accessor :data_category, :pager
+      # data_category; essentially the parent category
+      # raw_data_items; the raw hash of data_items found form the data_category
+      # this allows quick easy access to the data_item_values; if needed                
+      attr_accessor :data_category, :pager, :raw_data_items
       
       # we can only drill with a data_category that has data_items
       #

data/lib/amee/parser.rb

@@ -16,8 +16,10 @@ module Amee
       pager = {"pager" => data["children"].delete("pager")}
       categories = {"data_categories" => data["children"].delete("dataCategories")}
       data_items = {"data_items" => data["children"]["dataItems"].delete("rows")} if data["children"]["dataItems"]
+      raw_data_items = {"raw_data_items" => data_items}
       category.merge(categories).
       merge(data_items).
+      merge(raw_data_items).
       merge(pager).
       merge({"resource_path" => data["path"]})
     end
@@ -109,6 +111,18 @@ module Amee
     end
   end
   
+  class ProfileItemLocation < Parser
+    def self.process(data)
+      data.headers["location"].first
+    end
+  end
+  
+  class HttpOk < Parser
+    def self.process(data)
+      true
+    end
+  end
+  
   
   class Raw < Parser
     def self.process(data)
@@ -118,6 +132,9 @@ module Amee
   
   class Parser
     PARSERS = {
+      # @todo consitant naming
+      "ok" => HttpOk,
+      'profile_item.location' => ProfileItemLocation,
       'data.category' => DataCategory,
       'data.item' => DataItem,
       "data.item_value" => DataItemValue,

data/lib/amee/profile_api/profile.rb

@@ -15,7 +15,7 @@ module Amee
        end
       
       def create_profile_item(path_or_category, data_item_uid, params = {})
-        path = full_path + (path_or_category.is_a?(String) ? "#{path_or_category}" : "#{path_or_category.full_path}")
+        path = full_path + (path_or_category.is_a?(String) ? "#{path_or_category}" : "#{path_or_category.resource_path}")
         session.create_profile_item(path, data_item_uid, params)
       end
       
@@ -27,8 +27,8 @@ module Amee
         session.get_profile_category((full_path + path), options)
       end
       
-      def update_profile_item(path, fields)
-        session.update_profile_item((full_path + path), :fields => fields)
+      def update_profile_item(path, query)
+        session.update_profile_item((full_path + path), :query => query)
       end
  
       def destroy

data/lib/amee/profile_api/profile_item.rb

@@ -17,13 +17,13 @@ module Amee
       # @todo This currently will not work as profile data_item brings back a profile_category
       #       How stupid is that!
       def self.create(session, path, data_item_uid, fields ={})
-        hash = session.create_profile_item(path, data_item_uid, {:fields => fields, :hash_response => true})
+        hash = session.create_profile_item(path, data_item_uid, {:query => fields, :raw_response => true})
         self.from_hash(hash, session)
       end
       
       def update(fields = {})
         session.api_call(:put, "profile_item", self.full_path, 
-          :query => fields.merge({:representation => true})) do |response|
+          :query => fields) do |response|
           populate_from_hash!(response)
           self
         end

data/lib/amee/service.rb

@@ -42,7 +42,7 @@ module Amee
     def perform_request(type, method, path, options)
       attach_headers(options)
       response = self.class.send(type, path, options)
-      check_response(response.code)
+      check_response(response)
       Parser.parse(method, response)
     rescue Errno::ECONNREFUSED, SocketError
       raise Amee::Session::ServerNotFound, "Amee Server could not be found"
@@ -71,8 +71,8 @@ module Amee
     # @raise [Amee::UnAuthorized] if a auth_token could not be generated
     # @raise [Amee::SessionExpired] if a we get a 401
     # @raise [Amee::UnknownError] if we get something strange
-    def check_response(code)
-      case code
+    def check_response(response)
+      case response.code
         when 200, 201
           true
         when 403
@@ -82,7 +82,7 @@ module Amee
         when 404
           raise Amee::Session::NotFound.new("resource was not found")
         else
-          raise Amee::Session::UnknownError.new("super strange type unknown error")
+          raise Amee::Session::UnknownError.new("super strange type unknown error: #{response.code} :body #{response.body}")
       end
     end
       

data/lib/amee/session.rb

@@ -1,13 +1,14 @@
 module Amee
   class Session
     
-    class Expired < StandardError; end
-    class UnAuthorized < StandardError; end
-    class NotAuthenticated < StandardError; end
-    class PermissionDenied < StandardError; end
-    class NotFound < StandardError; end
-    class ServerNotFound < StandardError; end
-    class UnknownError < StandardError; end
+    class AmeeError < StandardError ;end
+    class Expired < AmeeError; end
+    class UnAuthorized < AmeeError; end
+    class NotAuthenticated < AmeeError; end
+    class PermissionDenied < AmeeError; end
+    class NotFound < AmeeError; end
+    class ServerNotFound < AmeeError; end
+    class UnknownError < AmeeError; end
     attr_accessor :auth_token, :cache, :service
     
     def self.create(username = nil, password = nil)
@@ -147,20 +148,30 @@ module Amee
       end
     end
     
+    # @note representation FULL is not working on AMEE VERSION 2.0
+    #   ticket has been raised
+    # 
     # @return [Amee::ProfileApi::ProfileItem]
     def update_profile_item(path, options = {})
       @cache.clear
-      api_call(:put, "profile_item", path, :query => {:representation => options[:representation] || true}.merge(options[:fields])) do |response|
+      api_call(:put, options[:representation] ? "profile_item" : "ok", path, 
+        :body => {:representation => options[:representation] ? "full" : ""}.merge(options[:query])) do |response|
+        return response if (options[:raw_response] || !response.is_a?(Hash))
         Amee::ProfileApi::ProfileItem.from_hash(response, self)
       end
     end
     
+    
+    # If you want a full representation; which is the profile category by the way
+    # then pass :representation => true in the options hash
+    #
     # @return [Amee::ProfileApi::ProfileCategory]
+    # @return [String] the location of the new resource if representation is passed in options
     def create_profile_item(path, uid, options = {})
       @cache.clear
-      api_call(:post, "create.profile_item", path, 
-        :query => {:dataItemUid => uid, :representation => "full"}.merge(options[:fields])) do |response|
-          return response if options[:hash_response]
+      api_call(:post, options[:representation] ? "create.profile_item" : "profile_item.location", path, 
+        :query => {:dataItemUid => uid, :representation => options[:representation] ? "full" : ""}.merge(options[:query])) do |response|
+          return response if (options[:raw_response] || !response.is_a?(Hash))
           Amee::ProfileApi::ProfileCategory.from_hash(response, self) do |profile_category|
             profile_category.lazy_loaded = true
           end
@@ -233,8 +244,9 @@ module Amee
     end
     
     protected
+    require 'digest/md5'
     def cache_key(path, params = {})
-      path + params.map { |key,value| "#{key}=#{value}" }.join('/')
+      Digest::MD5.hexdigest(path + params.map { |key,value| "#{key}=#{value}" }.join('/'))
     end
       
   end

data/lib/amee.rb

@@ -36,5 +36,5 @@ require "amee/profile_api/profile_category"
 require "amee/profile_api/profile"
 
 module Amee
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 end

data/spec/service_spec.rb

@@ -16,7 +16,7 @@ describe "Given FakeRequests Are Setup" do
     
     it "should send a request with headers of AuthToken And Accept" do
       Amee::Service.should_receive(:get).
-        with("/path", {:headers => {"authToken" => "whatever token", "Accept" => Amee::Config[:accept]}}).
+        with("http://stage.amee.com/path", {:headers => {"authToken" => "whatever token", "Accept" => Amee::Config[:accept]}}).
         and_return(mock("response",:code => 200))
       @service.get("raw", "/path")
     end

data/spec/session_spec.rb

@@ -38,7 +38,7 @@ describe "Given we have setup the fake requests" do
     end
     
     it "should try to use default cache expires_in if none given" do
-      @amee_session.cache.should_receive(:store).with("/path", "result", {:expires_in=>86400})
+      @amee_session.cache.should_receive(:store).with(Digest::MD5.hexdigest("/path"), "result", {:expires_in=>86400})
       @amee_session.store_resource("/path", "result")
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hookercookerman-amee
 version: !ruby/object:Gem::Version 
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors: 
 - Richard Hooker