amee 4.3.2 → 4.4.0

data/spec/connection_spec.rb

@@ -6,34 +6,32 @@ require 'spec_helper.rb'
 describe AMEE::Connection do
 
   it "requires server name, username, and password" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start => nil)
+
     lambda{AMEE::Connection.new(nil, nil, nil)}.should raise_error
     lambda{AMEE::Connection.new(nil, 'username', nil)}.should raise_error
     lambda{AMEE::Connection.new(nil, nil, 'password')}.should raise_error
     lambda{AMEE::Connection.new(nil, 'username', 'password')}.should raise_error
-    lambda{AMEE::Connection.new('server.example.com', nil, nil)}.should raise_error
-    lambda{AMEE::Connection.new('server.example.com', 'username', nil)}.should raise_error
-    lambda{AMEE::Connection.new('server.example.com', nil, 'password')}.should raise_error
-    c = AMEE::Connection.new('server.example.com', 'username', 'password')
+    lambda{AMEE::Connection.new('stage.amee.com', nil, nil)}.should raise_error
+    lambda{AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, nil)}.should raise_error
+    lambda{AMEE::Connection.new('stage.amee.com', nil, 'password')}.should raise_error
+    c = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
     c.should be_valid
   end
 
   it "has default timeout of 60 seconds" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start => nil)
-    c = AMEE::Connection.new('server.example.com', 'username', 'password')
+
+    c = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
     c.timeout.should be(60)
   end
 
   it "can set timeout" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start => nil)
-    c = AMEE::Connection.new('server.example.com', 'username', 'password')
+    c = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
     c.timeout = 30
     c.timeout.should be(30)
   end
 
   it "can set timeout on creation" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start => nil)
-    c = AMEE::Connection.new('server.example.com', 'username', 'password', :timeout => 30)
+    c = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD, :timeout => 30)
     c.timeout.should be(30)
   end
 
@@ -41,199 +39,210 @@ end
 
 describe AMEE::Connection, "with authentication" do
 
+  describe "using a version 1 api key" do
+    use_vcr_cassette "AMEE_Connection_with_authentication/using a v1 key", :record => :new_episodes
+    it "detects the API version (1)" do
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V1_API_KEY, AMEE_V1_PASSWORD)
+      amee.authenticate
+      amee.authenticated?.should be_true
+      amee.version.should == 1.0
+    end
+  end
+
+  describe "using a version 2 api key" do
+    
   it "should start out unauthenticated" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start => nil)
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
+    amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
     amee.authenticated?.should be_false
   end
 
-  it "detects the API version (1)" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '200', :body => '0', :'[]' => 'dummy_auth_token_data'))
-      mock.should_receive(:finish => nil)
+  it "detects the API version (2 - XML) normally" do
+    VCR.use_cassette('AMEE_Connection_with_authentication/using_a_v2_key/detects the API version for XML') do
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+      amee.authenticate
+      amee.authenticated?.should be_true
+      amee.version.should == 2.0
     end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    amee.authenticate
-    amee.authenticated?.should be_true
-    amee.version.should == 1.0
   end
 
-  it "detects the API version (2 - XML)" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '200', :body => '<?xml version="1.0" encoding="UTF-8"?><Resources><SignInResource><Next>/auth</Next><User uid="DB2C6DA7EAA7"><Status>ACTIVE</Status><Type>STANDARD</Type><GroupNames><GroupName>amee</GroupName><GroupName>Standard</GroupName><GroupName>All</GroupName></GroupNames><ApiVersion>2.0</ApiVersion></User></SignInResource></Resources>', :'[]' => 'dummy_auth_token_data'))
-      mock.should_receive(:finish => nil)
+  it "detects the API version (2 - JSON)" do
+    VCR.use_cassette('AMEE_Connection_with_authentication/using_a_v2_key/detects the API version for JSON') do
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+      amee.authenticate
+      amee.authenticated?.should be_true
+      amee.version.should == 2.0
     end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    amee.authenticate
-    amee.authenticated?.should be_true
-    amee.version.should == 2.0
   end
 
-  it "detects the API version (2 - JSON)" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '200', :body => '{ "next" : "/auth","user" : { "apiVersion" : "2.0","groupNames" : [ "amee","Standard","All"],"status" : "ACTIVE","type" : "STANDARD","uid" : "DB2C6DA7EAA7"}}', :'[]' => 'dummy_auth_token_data'))
-      mock.should_receive(:finish => nil)
-    end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    amee.authenticate
-    amee.authenticated?.should be_true
-    amee.version.should == 2.0
   end
 
-  it "should be able to get private URLs" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '401', :body => '')).once
-      mock.should_receive(:request).and_return(flexmock(:code => '200', :body => '', :'[]' => 'dummy_auth_token_data')).once
-      mock.should_receive(:request).and_return { |request|
-        if request['authToken'] == 'dummy_auth_token_data'
-          flexmock(:code => '200', :body => '<?xml version="1.0" encoding="UTF-8"?><Resources><DataCategoryResource><Path/><DataCategory created="2007-07-27 09:30:44.0" modified="2007-07-27 09:30:44.0" uid="CD310BEBAC52"><Name>Root</Name><Path/><Environment uid="5F5887BCF726"/></DataCategory><Children><DataCategories><DataCategory uid="BBA3AC3E795E"><Name>Home</Name><Path>home</Path></DataCategory><DataCategory uid="9E5362EAB0E7"><Name>Metadata</Name><Path>metadata</Path></DataCategory><DataCategory uid="6153F468BE05"><Name>Test</Name><Path>test</Path></DataCategory><DataCategory uid="263FC0186834"><Name>Transport</Name><Path>transport</Path></DataCategory><DataCategory uid="2957AE9B6E6B"><Name>User</Name><Path>user</Path></DataCategory></DataCategories></Children></DataCategoryResource></Resources>')        
-        else
-          flexmock(:code => '401', :body => '')
-        end
-      }.once
-      mock.should_receive(:finish => nil)
-    end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    amee.get('/data') do |response|
-      response.should_not be_empty
+  describe "hitting_private_urls" do
+    use_vcr_cassette
+
+    it "should be able to get private URLs" do
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+      amee.get('/data') do |response|
+        response.should_not be_empty
+      end
+      amee.authenticated?.should be_true
     end
-    amee.authenticated?.should be_true
   end
 
-  it "should handle 404s gracefully" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start => nil, :request => flexmock(:code => '404', :body => ""), :finish => nil)
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    lambda{amee.get('/missing_url')}.should raise_error(AMEE::NotFound, "The URL was not found on the server.\nRequest: GET /missing_url")
+  describe "handling 404s" do
+    use_vcr_cassette
+    it "should handle 404s gracefully" do
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+      lambda{amee.get('/missing_url')}.should raise_error(AMEE::NotFound, "The URL was not found on the server.\nRequest: GET /missing_url")
+    end
   end
 
-  it "should raise error if permission for operation is denied" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '403', :body => '{}'))
-      mock.should_receive(:finish => nil)
+  describe "raising errors if permission denied" do
+    use_vcr_cassette
+
+    it "should raise error if permission for operation is denied" do
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+      lambda {
+        amee.get('/data/lca/ecoinvent')
+      }.should raise_error(AMEE::PermissionDenied)
     end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    lambda {
-      amee.get('/data')
-    }.should raise_error(AMEE::PermissionDenied,"You do not have permission to perform the requested operation.
-Request: GET /data
-Response: {}")
   end
 
-  it "should raise error if authentication succeeds, but permission for operation is denied" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '401', :body => ''),
-                                               flexmock(:code => '200', :body => '', :'[]' => 'dummy_auth_token_data'),
-                                               flexmock(:code => '403', :body => '{}'))
-      mock.should_receive(:finish => nil)
+  describe "raising unhandled errors" do
+    it "should raise error if unhandled errors occur in connection" do
+
+      @error_response = {
+        :status => 500,
+        :body => ""
+      }
+
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+
+      VCR.use_cassette("AMEE_Connection/v2/raising unhandled errors") do
+        amee.authenticate
+      end
+      stub_request(:any, "https://stage.amee.com/data").to_return(@error_response)
+
+      lambda {
+        amee.get('/data')
+      }.should raise_error(AMEE::UnknownError)
     end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    lambda {
-      amee.get('/data')
-    }.should raise_error(AMEE::PermissionDenied,"You do not have permission to perform the requested operation.
-Request: GET /data
-Response: {}")
-    amee.authenticated?.should be_true
   end
 
-  it "should raise error if unhandled errors occur in connection" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '500', :body => '{}'))
-      mock.should_receive(:finish => nil)
+  it "should re-authenticate and refresh authtoken when authtoken expires" do
+    VCR.use_cassette('AMEE_Connection_with_authentication/should re-authenticate and refresh authtoken when authtoken expires') do
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+      amee.auth_token = 'old_token'
+      amee.get('/profiles')
+      amee.auth_token.should_not eql 'old_token'
+    end
+  end
+  
+  it "should refresh authtoken when authtoken is changed" do
+    VCR.use_cassette('AMEE_Connection_with_authentication/should refresh authtoken when authtoken is changed') do
+      amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+      amee.get('/profiles')
+      old_token = amee.auth_token
+      #sleep(65) # Wait 65 seconds so platform changes auth token. This is only required when generating the cassette.
+      amee.get('/profiles')
+      amee.auth_token.should_not eql old_token
     end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    lambda {
-      amee.get('/data')
-    }.should raise_error(AMEE::UnknownError,"An error occurred while talking to AMEE: HTTP response code 500.
-Request: GET /data
-Response: {}")
   end
 
 end
 
 describe AMEE::Connection, "with retry enabled" do
-
+  use_vcr_cassette
   [
-    Timeout::Error,
-    Errno::EINVAL, 
-    Errno::ECONNRESET, 
-    EOFError,
-    Net::HTTPBadResponse, 
-    Net::HTTPHeaderSyntaxError, 
-    Net::ProtocolError
+    AMEE::TimeOut,
   ].each do |e|
 
-    it "should retry after #{e.name} the correct number of times" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).and_raise(e.new).twice
-        mock.should_receive(:request).and_return(flexmock(:code => '200', :body => '{}')).once
-        mock.should_receive(:finish => nil)
+    before(:each) do
+
+      @amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD, :retries => 2)
+
+      VCR.use_cassette("AMEE_Connection/v2/raising unhandled errors") do
+        @amee.authenticate
       end
-      amee = AMEE::Connection.new('server.example.com', 'username', 'password', :retries => 2)
+
+    end
+
+    it "should retry after #{e.name} the correct number of times" do
+
+      @error_response = {
+        :status => 408,
+        :body => ""
+      }
+      
+
+      stub_request(:any, "https://stage.amee.com/data").to_return(@error_response).times(2).
+      then.to_return(:status => 200, :body => {})
+
       lambda {
-        amee.get('/data')
-      }.should_not raise_error        
+        @amee.get('/data')
+      }.should_not raise_error
     end
 
     it "should retry #{e.name} the correct number of times and raise error on failure" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).and_raise(e.new).times(3)
-        mock.should_receive(:finish => nil)
-      end
-      amee = AMEE::Connection.new('server.example.com', 'username', 'password', :retries => 2)
+
+      @error_response = {
+        :status => 408,
+        :body => ""
+      }
+      stub_request(:any, "https://stage.amee.com/data").to_return(@error_response).times(3)
+
       lambda {
-        amee.get('/data')
+        @amee.get('/data')
       }.should raise_error(e)
     end
   end
-  
+
   [
-    '502',
-    '503',
-    '504'
+    502,
+    503,
+    504
   ].each do |e|
 
+    # binding.pry
+
+    before(:each) do
+      VCR.use_cassette("AMEE_Connection/v2/raising unhandled errors") do
+        @amee.authenticate
+      end  
+
+      @error_response = {
+        :status => e,
+        :body => {}
+      }
+      @amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD, :retries => 2)
+
+    end
+
     it "should retry after #{e} the correct number of times" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).and_return(flexmock(:code => e, :body => '{}')).twice
-        mock.should_receive(:request).and_return(flexmock(:code => '200', :body => '{}')).once
-        mock.should_receive(:finish => nil)
-      end
-      amee = AMEE::Connection.new('server.example.com', 'username', 'password', :retries => 2)
+
+      stub_request(:any, "https://stage.amee.com/data").to_return(:status => e, :body => {}).times(2).
+      then.to_return(:status => 200, :body => {})
+
       lambda {
-        amee.get('/data')
-      }.should_not raise_error        
+        @amee.get('/data')
+      }.should_not raise_error
     end
 
     it "should retry #{e} the correct number of times and raise error on failure" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).and_return(flexmock(:code => e, :body => '{}')).times(3)
-        mock.should_receive(:finish => nil)
-      end
-      amee = AMEE::Connection.new('server.example.com', 'username', 'password', :retries => 2)
+
+      stub_request(:any, "https://stage.amee.com/data").to_return(@error_response)
       lambda {
-        amee.get('/data')
+        @amee.get('/data')
       }.should raise_error(AMEE::ConnectionFailed)
     end
-  end  
-  
+  end
+
 end
 
 describe AMEE::Connection, "with incorrect server name" do
 
+  use_vcr_cassette
   it "should raise a useful error" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start).and_raise(SocketError.new)
-    amee = AMEE::Connection.new('badservername.example.com', 'username', 'password')
+    amee = AMEE::Connection.new('badservername.example.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
     lambda{
       amee.get('/')
     }.should raise_error(AMEE::ConnectionFailed, "Connection failed. Check server name or network connection.")
@@ -243,56 +252,88 @@ end
 
 describe AMEE::Connection, "with bad authentication information" do
 
-  it "should be capable of making requests for public URLs" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start => nil, :request => flexmock(:code => '200', :body => ""), :finish => nil)
-    amee = AMEE::Connection.new('server.example.com', 'wrong', 'details')
-    lambda{amee.get('/')}.should_not raise_error
+  describe "hitting a private url" do
+    use_vcr_cassette
+    it "should get an authentication failure" do
+      amee = AMEE::Connection.new('stage.amee.com', 'wrong', 'details')
+      lambda{
+        amee.get('/data')
+      }.should raise_error(AMEE::AuthFailed, "Authentication failed. Please check your username and password. (tried wrong,details)")
+    end
   end
 
-  it "should get an authentication failure when accessing private URLs" do
-    flexmock(Net::HTTP).new_instances.should_receive(:start => nil, :request => flexmock(:code => '401', :body => "", :'[]' => nil), :finish => nil)
-    amee = AMEE::Connection.new('server.example.com', 'wrong', 'details')
-    lambda{amee.get('/data')}.should raise_error(AMEE::AuthFailed, "Authentication failed. Please check your username and password. (tried wrong,details)")
+  # according to the docs, public urls should not be accessible without
+  # an api key either
+  # http://www.amee.com/developer/docs/apc.php#auth-reference
+  describe "hitting a public url" do
+    use_vcr_cassette
+    it "should not be capable of making requests for public URLs" do
+      amee = AMEE::Connection.new('stage.amee.com', 'wrong', 'details')
+      lambda{
+        amee.get('/')
+      }.should raise_error
+    end
   end
 
+
+
 end
 
 describe AMEE::Connection, "with authentication , doing write-requests" do
-
+  use_vcr_cassette
   it "should be able to send post requests" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '200', :body => ''))
-      mock.should_receive(:finish => nil)
-    end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    amee.post('/profiles', :test => 1, :test2 => 2) do |response|
-      response.should be_empty
+    amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+    amee.post('/profiles', {:profile => true}) do |response|
+      response.code.should be_200
     end
   end
 
-  it "should be able to send put requests" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '200', :body => ''))
-      mock.should_receive(:finish => nil)
-    end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    amee.put('/profiles/ABC123', :test => 1, :test2 => 2) do |response|
-      response.should be_empty
-    end
-  end
+  describe "working with an existing profile" do
+
+    describe "sending updates to existing items" do
+      use_vcr_cassette
+      it "should be possible" do
 
-  it "should be able to send delete requests" do
-    flexmock(Net::HTTP).new_instances do |mock|
-      mock.should_receive(:start => nil)
-      mock.should_receive(:request).and_return(flexmock(:code => '200', :body => ''))
-      mock.should_receive(:finish => nil)
+        amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+
+        profile_creation_post = amee.post('/profiles', {:profile => true})
+        profile = JSON.parse(profile_creation_post.body)['profile']['uid']
+
+        # fetch the new_item type uid to create
+        new_item_drill = amee.get('/data/test/apitests/drill')
+        new_item_uid = JSON.parse(new_item_drill.body)['choices']['choices'].first['value']
+        # create a new item
+        new_profile = amee.post("/profiles/#{profile}/test/apitests", :dataItemUid => new_item_uid)
+        # update the new item
+        path = new_profile.headers_hash['location'].gsub('https://stage.amee.com', '')
+        amee.put(path, :dataItemUid => new_item_uid) do |response|
+          response.should be_empty
+        end
+      end
     end
-    amee = AMEE::Connection.new('server.example.com', 'username', 'password')
-    amee.delete('/profiles/ABC123') do |response|
-      response.should be_empty
+
+    describe "deleting existing items" do
+      use_vcr_cassette
+      it "should also be possible" do
+
+        amee = AMEE::Connection.new('stage.amee.com', AMEE_V2_API_KEY, AMEE_V2_PASSWORD)
+        profile_creation_post = amee.post('/profiles', {:profile => true})
+        profile = JSON.parse(profile_creation_post.body)['profile']['uid']
+
+        # fetch the new_item type uid to create
+        new_item_drill = amee.get('/data/test/apitests/drill')
+        new_item_uid = JSON.parse(new_item_drill.body)['choices']['choices'].first['value']
+        # create a new item
+        new_profile = amee.post("/profiles/#{profile}/test/apitests", :dataItemUid => new_item_uid)
+        # delete the new item
+        path = new_profile.headers_hash['location'].gsub('https://stage.amee.com', '')
+        amee.delete(path) do |response|
+          response.should be_empty
+        end
+      end
     end
+
+
   end
 
 end