conjur-api 4.9.1 → 4.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05d952363d80aa2180905c6b41fc2c7eb603538d
-  data.tar.gz: 8ed90479978bec0f925c366ec7e5a5b6709ec834
+  metadata.gz: 40b8b3e33ac15bc66d3663948bb3d7da081615d6
+  data.tar.gz: 1c79f61e8e87c94089cd9439833e1b118fc68e68
 SHA512:
-  metadata.gz: 6767b1f5ed0d478520ac98553a7d1fb8ddf111cd4de12d24f70489d48addb403520e960501a7ea61b3463f045d296cd507f6ef3c87087860a00b805ee49e95f9
-  data.tar.gz: a7dae6329da4acd092fa408feb71b79b3b169ac7c2da189173bc837e5133ae7dd8adad71dabf288ebb063f7628a9607a5afaf1b30c0abba4bd5f2a58b917b65a
+  metadata.gz: 1e2b831d564b9cf0f9df2f55bfcd50a138b0c607a513de45e2974b9f6ed4ee9637a7ae3c4e5c6b6024d1445ec8bcddd1741d646b1d8dacc078838935be9c3ca3
+  data.tar.gz: 2d400fc3541fd4235bfb445a66a6112cfff95c5e962a6ca21de94ec68a824b8e1d4823cd7f88b71a3921163fd44c14d9dcfa004e4b02986531ceff9d819c30a4

data/README.md

@@ -1,6 +1,6 @@
 # Conjur::API
 
-TODO: Write a gem description
+Programmatic Ruby access to the Conjur API.
 
 ## Installation
 
@@ -18,17 +18,18 @@ Or install it yourself as:
 
 ## Usage
 
-Default service ports:
- - authn: 5000,
- - authz: 5100.
+To instantiate the API, using configuration stored stored in `~/.conjurrc`:
 
 ```ruby
-ENV['CONJUR_ACCOUNT'] = 'account'
-conjur = Conjur::API.new_from_key 'admin', 'vJfQbiieBcv4SlxTZ7ULznc1zHZ4z+0sx5to3hLOic0='
-some_user = conjur.user 'foo'
-
+require 'conjur/cli'
+Conjur::Config.load
+conjur = Conjur::API.new_from_key username, api_key
 ```
 
+You can find the username and api_key in ~/.netrc after you've logged in.
+
+Fancier/different init scenarios are possible but this should be a good start!
+
 ## Contributing
 
 1. Fork it

data/lib/conjur-api/version.rb

@@ -20,6 +20,6 @@
 #
 module Conjur
   class API
-    VERSION = "4.9.1"
+    VERSION = "4.9.2"
   end
 end

data/lib/conjur/configuration.rb

@@ -75,6 +75,10 @@ module Conjur
         define_method("#{name}=") do |value|
           set name, value
         end
+
+        define_method("#{name}_env_var") do
+          allow_env ? env_var : nil
+        end
         
         define_method(name) do
           if supplied.member?(name)
@@ -142,7 +146,7 @@ module Conjur
         when 'test', 'development', 'appliance'
           "http://localhost:#{service_base_port + service_port_offset}"
         else
-          "https://#{service_name}-#{stack}-conjur.herokuapp.com"
+          "https://#{herokuize service_name}-#{stack}-conjur.herokuapp.com"
         end
       end
     end
@@ -155,7 +159,7 @@ module Conjur
         when 'test', 'development', 'appliance'
           "http://localhost:#{service_base_port + service_port_offset}"
         else
-          "https://#{service_name}-#{account}-conjur.herokuapp.com"
+          "https://#{herokuize service_name}-#{account}-conjur.herokuapp.com"
         end
       end
     end
@@ -168,6 +172,11 @@ module Conjur
       end
     end
     
+    # Heroku: Name must start with a letter and can only contain lowercase letters, numbers, and dashes.
+    def herokuize name
+      name.downcase.gsub(/[^a-z0-9\-]/, '-')
+    end
+    
     def supplied
       @supplied ||= {}
     end

data/lib/conjur/exists.rb

@@ -24,12 +24,6 @@ module Conjur
       begin
         self.head(options)
         true
-      rescue RestClient::Forbidden
-        # rationale is: exists? should return true iff creating a resource with
-        # the same name would fail (not by client's fault). Why it would fail
-        # doesn't matter that much.
-        # (Plus, currently it always 403s when the resource exists but is unaccessible.)
-        true
       rescue RestClient::ResourceNotFound
         false
       end

data/lib/conjur/resource.rb

@@ -22,7 +22,6 @@ require 'conjur/annotations'
 
 module Conjur
   class Resource < RestClient::Resource
-    include Exists
     include HasAttributes
     include PathBased
     
@@ -52,6 +51,17 @@ module Conjur
       end
       self.put(options)
     end
+    
+    def exists?(options = {})
+      begin
+        self.head(options)
+        true
+      rescue RestClient::Forbidden
+        true
+      rescue RestClient::ResourceNotFound
+        false
+      end
+    end
 
     # Lists roles that have a specified permission on the resource.
     def permitted_roles(permission, options = {})
@@ -116,6 +126,8 @@ module Conjur
       params[:acting_as] = options[:acting_as] if options[:acting_as]
       self["?#{params.to_query}"].get(options)
       true
+    rescue RestClient::Forbidden
+      false
     rescue RestClient::ResourceNotFound
       false
     end

data/spec/lib/exists_spec.rb

@@ -10,7 +10,9 @@ describe Conjur::Exists do
 
   context "when forbidden" do
     before { subject.stub(:head) { raise RestClient::Forbidden }}
-    its(:exists?) { should be_true }
+    it "propagates the error" do
+      lambda { subject.exists? }.should raise_error(RestClient::Forbidden)
+    end
   end
 
   context "when not found" do

data/spec/lib/resource_spec.rb

@@ -74,6 +74,36 @@ describe Conjur::Resource, api: :dummy, logging: :temp do
     end
   end
 
+  describe "#exists" do
+    let(:uri) { "#{authz_host}/some-account/resources/the-kind/resource-id" }
+    it "sends HEAD /<resource>" do
+      RestClient::Request.should_receive(:execute).with(
+        method: :head,
+        url: uri,
+        headers: {}
+      )
+      subject.exists?
+    end
+    context "with status 204" do
+      before {
+        subject.stub(:head)
+      }
+      its(:exists?) { should be_true }
+    end
+    context "with status 404" do
+      before {
+        subject.stub(:head) { raise RestClient::ResourceNotFound }
+      }
+      its(:exists?) { should be_false }
+    end
+    context "with status 403" do
+      before {
+        subject.stub(:head) { raise RestClient::Forbidden }
+      }
+      its(:exists?) { should be_true }
+    end
+  end
+
   describe '#delete' do
     it 'simply deletes' do
       RestClient::Request.should_receive(:execute).with(
@@ -125,6 +155,30 @@ describe Conjur::Resource, api: :dummy, logging: :temp do
       )
       subject.permitted? 'fry'
     end
+    context "with status 204" do
+      before {
+        subject.stub_chain(:[], :get)
+      }
+      specify {
+        subject.permitted?('fry').should be_true
+      }
+    end
+    context "with status 404" do
+      before {
+        subject.stub_chain(:[], :get) { raise RestClient::ResourceNotFound }
+      }
+      specify {
+        subject.permitted?('fry').should be_false
+      }
+    end
+    context "with status 403" do
+      before {
+        subject.stub_chain(:[], :get) { raise RestClient::Forbidden }
+      }
+      specify {
+        subject.permitted?('fry').should be_false
+      }
+    end
   end
 
   describe '.all' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conjur-api
 version: !ruby/object:Gem::Version
-  version: 4.9.1
+  version: 4.9.2
 platform: ruby
 authors:
 - Rafał Rzepecki
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client