nightcrawler_swift 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce783e76729a865b6b3cd1fffbed84cc287234e9
-  data.tar.gz: 922f51e1130d4bb27b84bde8de018793c5b5a1c4
+  metadata.gz: 6210245e5388c7b1c73fa1c6ff58b2f7a2770320
+  data.tar.gz: 6071b7124b88f4293ea186b2755c99a7e6f3b407
 SHA512:
-  metadata.gz: ba0dc5e45b62d8011f321aba5c0e28487d5b496cde054a2197db3db5baeb2c9936a542ef5ef02ad9b3d324261b8677b6520140df048045ed4f579fd5bdb8db8e
-  data.tar.gz: a55710e1eddf95712cb5c3821b1853854b815ecf066ee6bf22c7b259e66f1dd7ad65f1f10405e4b8fe88b0b7c3482dbea3e05faaf9a1343fc1c7425af4152da1
+  metadata.gz: 65753c810f8691b5e06afe0db034d692ac9187d7d73e5b3be899a141fd1ffe3eb86114ebb2bcd4c6ebdffadc8760905a9a04d6da93a677f6c3db7a116824ee48
+  data.tar.gz: bd9c1a5bbc7dffd4e24c0d8efab7e50f0e8917af973b4b9798e2d9df14b9f61793d1414d196df03b292b6758e431a50c6b3913d22c5fbb198617d2492c587674

data/Changelog.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.6.0
+
+  - Upload command allows a custom max-age (issue #23)
+  - List command allows the following parameters: ```limit```, ```marker```, ```end_marker```, ```prefix```, ```format```, ```delimiter``` and ```path``` (issue #22)
+  - Download command uses the internal_url by default (issue #25)
+  - CLI now supports a ```--max-age``` to override the default max_age
+  - Included ```Expires``` header to upload command based on max_age configuration (issue #9)
+  - The _password_ option can be defined by the env variable ```NSWIFT_PASSWORD``` (issue #21)
+  - Support for SSL Client Certificates through the options: ```ssl_client_cert```, ```ssl_client_key``` and ```ssl_ca_file```
+  - Configurable ```internal_url```
+
 ## 0.5.0
 
   - CLI now supports ```-b/--bucket``` to override the default bucket/container (issue #10)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nightcrawler_swift (0.5.0)
+    nightcrawler_swift (0.6.0)
       multi_mime (>= 1.0.1)
       rest-client
 

data/README.md

@@ -41,16 +41,39 @@ config.nightcrawler_swift.password = "my_password1"
 config.nightcrawler_swift.auth_url = "https://auth.url.com:123/v2.0/tokens"
 ```
 
+The __password__ option can be left blank and be defined by the env variable __NSWIFT_PASSWORD__. The env variable will take precedence if the option was set.
+
 __Optional configurations:__
 
 ```ruby
 config.nightcrawler_swift.max_age = 3600 # default: nil
-config.nightcrawler_swift.verify_ssl = true # default: false
 config.nightcrawler_swift.timeout = 10 # in seconds, default: nil
-config.nightcrawler_swift.admin_url = "https://api.host.com/v1/AUTH_1234" # default: uses the admin_url returned by authentication
-config.nightcrawler_swift.public_url = "http://asset.host.com/v1/AUTH_1234" # default: uses the public_url returned by authentication
-config.nightcrawler_swift.retries = 3 # default: 5, to disable set it to false
-config.nightcrawler_swift.max_retry_time = 64 # in seconds, default: 30
+
+# default: uses the admin_url returned by authentication
+config.nightcrawler_swift.admin_url = "https://api.host.com/v1/AUTH_1234"
+
+# default: uses the public_url returned by authentication
+config.nightcrawler_swift.public_url = "http://asset.host.com/v1/AUTH_1234"
+
+# default: 5, to disable set it to false
+config.nightcrawler_swift.retries = 3
+
+# in seconds, default: 30
+config.nightcrawler_swift.max_retry_time = 64
+
+# default: false. You could use OpenSSL::SSL::VERIFY_PEER
+config.nightcrawler_swift.verify_ssl = true
+
+# default: nil
+config.nightcrawler_swift.ssl_client_cert =
+  OpenSSL::X509::Certificate.new(File.read("cert.pem"))
+
+# default: nil
+config.nightcrawler_swift.ssl_client_key =
+  OpenSSL::PKey::RSA.new(File.read("key.pem"), "passphrase, if any")
+
+# default: nil
+config.nightcrawler_swift.ssl_ca_file = "ca_certificate.pem"
 ```
 
 By default it will use ```Rails.logger``` as logger, to change that use a different logger in configurations, like:
@@ -95,16 +118,40 @@ NightcrawlerSwift.configure({
 })
 ```
 
+The __password__ option can be left blank and be defined by the env variable __NSWIFT_PASSWORD__. The env variable will take precedence if the option was set.
+
+
 __Optional configurations:__
 
 ```ruby
 max_age: 3600,
-verify_ssl: true,
 timeout: 10, # in seconds
-admin_url: "https://api.host.com/v1/AUTH_1234", # default: uses the admin_url returned by authentication
-public_url: "http://asset.host.com/v1/AUTH_1234", # default: uses the public_url returned by authentication
-retries: 3, # default: 5, to disable set it to false
-max_retry_time: 64 # in seconds, default: 30
+
+# default: uses the admin_url returned by authentication
+admin_url: "https://api.host.com/v1/AUTH_1234",
+
+# default: uses the public_url returned by authentication
+public_url: "http://asset.host.com/v1/AUTH_1234",
+
+# default: 5, to disable set it to false
+retries: 3,
+
+# in seconds, default: 30
+max_retry_time: 64
+
+# default: false. You could use OpenSSL::SSL::VERIFY_PEER
+verify_ssl: true,
+
+# default: nil
+ssl_client_cert:
+  OpenSSL::X509::Certificate.new(File.read("cert.pem")),
+
+# default: nil
+ssl_client_key:
+  OpenSSL::PKey::RSA.new(File.read("key.pem"), "passphrase, if any"),
+
+# default: nil
+ssl_ca_file: "ca_certificate.pem"
 ```
 
 By default it will use ```Logger.new(STDOUT)``` as logger, to change that use:
@@ -149,6 +196,13 @@ $ nswift list
 ```sh
 $ nswift upload <real_path> <swift_path> # nswift upload robots.txt assets/robots.txt
 ```
+
+Upload also supports a custom max-age, to override the value defined in ".nswiftrc", example:
+
+```sh
+$ nswift upload <real_path> <swift_path> --max-age VALUE # nswift upload readme assets/readme.md --max-age 300
+```
+
 ```sh
 $ nswift download <swift_path> # nswift download assets/robots.txt > my-robots.txt
 ```
@@ -183,7 +237,15 @@ upload.execute "my_file_path.txt", File.open("../my_file_fullpath.txt", "r")
 # true / false
 ```
 
-_This upload command was not designed to send very large files_
+_This upload command was not designed to send very large files_.
+
+It will accept a custom max-age, overriding the configured value through ```NightcrawlerSwift.configure```, example:
+
+```ruby
+upload = NightcrawlerSwift::Upload.new
+upload.execute "readme", File.open("readme.md", "r"), max_age: 300
+# true / false
+```
 
 ### Download
 
@@ -203,6 +265,16 @@ list.execute
 # [{"hash": "...", "name": "my_file_path.txt"}, {}, {}, ...]
 ```
 
+This command supports the following parameters: __limit, marker, end_marker, prefix, format, delimiter, path__
+
+Example:
+
+```ruby
+list = NightcrawlerSwift::List.new
+list.execute prefix: '/some/path'
+# [{"hash": "...", "name": "/some/path/with/my_file_path.txt"}, {}, {}, ...]
+```
+
 ### Delete
 
 ```ruby

data/lib/nightcrawler_swift.rb

@@ -1,3 +1,4 @@
+require "cgi"
 require "date"
 require "logger"
 require "digest"
@@ -6,6 +7,8 @@ require "multi_mime"
 require "rest_client"
 require "nightcrawler_swift/version"
 require "nightcrawler_swift/exceptions"
+require "nightcrawler_swift/ext/hash"
+require "nightcrawler_swift/options"
 require "nightcrawler_swift/gateway"
 require "nightcrawler_swift/connection"
 require "nightcrawler_swift/command"
@@ -34,20 +37,19 @@ module NightcrawlerSwift
     # - auth_url
     #
     # - max_age (optional, default: nil)
-    # - verify_ssl (optional, default: false)
     # - timeout (in seconds. Optional, default: nil)
     #
     # - retries (default: 3)
     # - max_retry_time (in seconds, default: 30)
     #
+    # - verify_ssl (optional, default: false)
+    # - ssl_client_cert (optional, default: nil)
+    # - ssl_client_key (optional, default: nil)
+    # - ssl_ca_file (optional, default: nil)
+    #
     def configure opts = {}
-      defaults = {verify_ssl: false, retries: 5, max_retry_time: 30}
-      @options = OpenStruct.new(defaults.merge(opts))
-
-      if @options.max_age and not @options.max_age.is_a?(Numeric)
-        raise Exceptions::ConfigurationError.new "max_age should be an Integer"
-      end
-
+      opts.symbolize_keys!
+      @options = Options.new opts
       @connection = Connection.new
     end
 

data/lib/nightcrawler_swift/cli/opt_parser.rb

@@ -34,6 +34,7 @@ module NightcrawlerSwift::CLI
     def configure_options
       @parser.separator "options:"
       configure_option_bucket
+      configure_option_max_age
       configure_option_config
       configure_option_help
       configure_option_version
@@ -43,8 +44,17 @@ module NightcrawlerSwift::CLI
       desc = "Alternative bucket/container name, overrides the '#{NightcrawlerSwift::CLI::CONFIG_FILE}' configuration"
       @parser.on("-b", "--bucket=NAME", String, desc) do |name|
         bucket = name.strip
-        @runner.options.bucket = bucket
-        @runner.log "Using bucket: #{@runner.options.bucket}"
+        @runner.options.config_hash[:bucket] = bucket
+        @runner.log "Using bucket: #{bucket}"
+      end
+    end
+
+    def configure_option_max_age
+      desc = "Custom max_age value, it overrides the value configured at '#{NightcrawlerSwift::CLI::CONFIG_FILE}'"
+      @parser.on("--max-age=VALUE", String, desc) do |value|
+        max_age = value.strip.to_i
+        @runner.options.config_hash[:max_age] = max_age
+        @runner.log "Using max_age: #{max_age}"
       end
     end
 

data/lib/nightcrawler_swift/cli/runner.rb

@@ -34,7 +34,7 @@ module NightcrawlerSwift::CLI
       @options.default_config_file = true
       @options.config_file = File.expand_path(File.join(user_home_dir, CONFIG_FILE))
       @options.cache_file = File.expand_path(File.join(user_home_dir, CACHE_FILE))
-      @options.bucket = nil
+      @options.config_hash = {}
     end
 
     def validate_command_and_options
@@ -55,12 +55,11 @@ module NightcrawlerSwift::CLI
     end
 
     def config_hash
-      @config_hash ||= JSON.parse(File.read(options.config_file))
+      @config_hash ||= JSON.parse(File.read(options.config_file), symbolize_names: true) rescue {}
     end
 
     def execute_command
-      NightcrawlerSwift.configure config_hash
-      NightcrawlerSwift.options.bucket = @options.bucket if @options.bucket
+      NightcrawlerSwift.configure config_hash.merge(@options.config_hash)
 
       connect_and_execute do
         command_method = "command_#{command_name_normalized}"

data/lib/nightcrawler_swift/command.rb

@@ -19,26 +19,30 @@ module NightcrawlerSwift
 
     protected
 
-    def get url, params = {}
-      prepare_params params
-      Gateway.new(url).request {|r| r.get params[:headers]}
+    def get url, args = {}
+      prepare_args args
+      Gateway.new(url).request {|r| r.get headers_and_params(args)}
     end
 
-    def put url, params = {}
-      prepare_params params
-      Gateway.new(url).request {|r| r.put params[:body], params[:headers]}
+    def put url, args = {}
+      prepare_args args
+      Gateway.new(url).request {|r| r.put args[:body], headers_and_params(args)}
     end
 
-    def delete url, params
-      prepare_params params
-      Gateway.new(url).request {|r| r.delete params[:headers]}
+    def delete url, args = {}
+      prepare_args args
+      Gateway.new(url).request {|r| r.delete headers_and_params(args)}
     end
 
     private
+    def prepare_args args
+      args[:headers] ||= {}
+      args[:headers]["X-Storage-Token"] = connection.token_id
+      args[:params] ||= {}
+    end
 
-    def prepare_params params
-      params[:headers] ||= {}
-      params[:headers]["X-Storage-Token"] = connection.token_id
+    def headers_and_params args
+      args[:headers].merge(params: args[:params])
     end
   end
 end

data/lib/nightcrawler_swift/commands/delete.rb

@@ -6,7 +6,7 @@ module NightcrawlerSwift
         raise Exceptions::ValidationError.new "Delete command requires a path parameter"
       end
 
-      response = delete "#{connection.upload_url}/#{path}", headers: {accept: :json }
+      response = delete "#{connection.upload_url}/#{path}", headers: { accept: :json }
       [200, 201].include?(response.code)
     end
 

data/lib/nightcrawler_swift/commands/download.rb

@@ -6,7 +6,7 @@ module NightcrawlerSwift
         raise Exceptions::ValidationError.new "Download command requires a path parameter"
       end
 
-      response = get "#{connection.public_url}/#{options.bucket}/#{path}"
+      response = get "#{connection.internal_url}/#{options.bucket}/#{path}"
       response.body
     end
 

data/lib/nightcrawler_swift/commands/list.rb

@@ -1,8 +1,16 @@
 module NightcrawlerSwift
   class List < Command
 
-    def execute
-      response = get connection.upload_url, headers: {accept: :json}
+    def execute args = {}
+      headers = { accept: :json }
+
+      # http://docs.openstack.org/api/openstack-object-storage/1.0/content/GET_showContainerDetails__v1__account___container__storage_container_services.html#GET_showContainerDetails__v1__account___container__storage_container_services-Request
+      params = {}
+      [:limit, :marker, :end_marker, :prefix, :format, :delimiter, :path].each do |accepted_parameter|
+        params[accepted_parameter] = args[accepted_parameter] if args[accepted_parameter]
+      end
+
+      response = get connection.upload_url, headers: headers, params: params
       JSON.parse(response.body)
     end
 

data/lib/nightcrawler_swift/commands/upload.rb

@@ -1,11 +1,14 @@
 module NightcrawlerSwift
   class Upload < Command
 
-    def execute path, file
-      content = file.read
-      headers = {etag: etag(content), content_type: content_type(file)}
-      headers.merge!(cache_control: "public, max-age=#{options.max_age}") if options.max_age
-      response = put "#{connection.upload_url}/#{path}", body: content, headers: headers
+    def execute path, file, opts = {}
+      body = file.read
+      headers = {etag: etag(body), content_type: content_type(file)}
+
+      max_age = opts[:max_age] || options.max_age
+      headers.merge!(cache_control: "public, max-age=#{max_age}", expires: expires(max_age)) if max_age
+
+      response = put "#{connection.upload_url}/#{path}", body: body, headers: headers
       [200, 201].include?(response.code)
     end
 
@@ -18,5 +21,9 @@ module NightcrawlerSwift
       Digest::MD5.hexdigest(content)
     end
 
+    def expires max_age
+      CGI.rfc1123_date(Time.now + max_age)
+    end
+
   end
 end

data/lib/nightcrawler_swift/connection.rb

@@ -1,7 +1,7 @@
 module NightcrawlerSwift
   class Connection
     attr_accessor :auth_response
-    attr_reader :token_id, :expires_at, :catalog, :admin_url, :upload_url, :public_url
+    attr_reader :token_id, :expires_at, :catalog, :admin_url, :upload_url, :public_url, :internal_url
 
     def connect!
       authenticate!
@@ -65,6 +65,7 @@ module NightcrawlerSwift
     def configure_urls
       @admin_url = opts.admin_url || @endpoints["adminURL"]
       @public_url = opts.public_url || @endpoints["publicURL"]
+      @internal_url = opts.internal_url || @endpoints["internalURL"]
       @upload_url = "#{@admin_url}/#{opts.bucket}"
     end
   end

data/lib/nightcrawler_swift/ext/hash.rb

@@ -0,0 +1,38 @@
+module NightcrawlerSwift
+  module Hash
+
+    unless {}.respond_to?(:symbolize_keys)
+      def symbolize_keys
+        {}.tap do |result|
+          keys.each {|k| result[k.to_sym] = self[k]}
+        end
+      end
+
+      def symbolize_keys!
+        self.tap do
+          keys.each {|k| self[k.to_sym] = delete(k)}
+        end
+      end
+    end
+
+    unless {}.respond_to?(:compact)
+      def compact
+        {}.tap do |result|
+          keys.each {|k| result[k] = self[k] unless self[k].nil?}
+        end
+      end
+
+      def compact!
+        self.tap do
+          keys.each do |k|
+            value = delete(k)
+            self[k] = value unless value.nil?
+          end
+        end
+      end
+    end
+
+  end
+end
+
+Hash.send :include, NightcrawlerSwift::Hash

data/lib/nightcrawler_swift/gateway.rb

@@ -18,8 +18,7 @@ module NightcrawlerSwift
 
       @resource = RestClient::Resource.new(
         @url,
-        verify_ssl: NightcrawlerSwift.options.verify_ssl,
-        timeout: NightcrawlerSwift.options.timeout
+        {timeout: options.timeout}.merge(ssl_options)
       )
     end
 
@@ -51,6 +50,22 @@ module NightcrawlerSwift
       NightcrawlerSwift.logger.debug message
     end
 
+    def options
+      NightcrawlerSwift.options
+    end
+
+    def ssl_options
+      [
+        :verify_ssl,
+        :ssl_client_cert,
+        :ssl_client_key,
+        :ssl_ca_file
+
+      ].inject({}) {|hash, key|
+        hash.tap {hash[key] = options[key]}
+      }.compact
+    end
+
     def recoverable? e
       @retries and
       !RETRY_BLACKLIST.include?(e.class) and

data/lib/nightcrawler_swift/options.rb

@@ -0,0 +1,27 @@
+module NightcrawlerSwift
+  class Options < OpenStruct
+
+    def initialize params = {}
+      params[:password] = ENV["NSWIFT_PASSWORD"] || params[:password]
+      super defaults.merge(params)
+      validate_max_age!
+    end
+
+    protected
+    def defaults
+      {
+        retries: 5,
+        max_retry_time: 30,
+        verify_ssl: false
+      }
+    end
+
+    private
+    def validate_max_age!
+      if self.max_age and not self.max_age.is_a?(Numeric)
+        raise Exceptions::ConfigurationError.new "max_age should be an Integer"
+      end
+    end
+
+  end
+end

data/lib/nightcrawler_swift/version.rb

@@ -1,3 +1,3 @@
 module NightcrawlerSwift
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/lib/nightcrawler_swift/cli/opt_parser_spec.rb

@@ -4,7 +4,7 @@ require "nightcrawler_swift/cli"
 describe NightcrawlerSwift::CLI::OptParser do
 
   let :runner do
-    instance_double "Runner", options: OpenStruct.new(bucket: nil, config_file: nil, default_config_file: true)
+    instance_double "Runner", options: OpenStruct.new(config_hash: {}, config_file: nil, default_config_file: true)
   end
 
   let :config_dir do
@@ -108,7 +108,26 @@ describe NightcrawlerSwift::CLI::OptParser do
           allow(runner).to receive(:argv).and_return([command])
           allow(runner).to receive(:log)
           subject.parse!
-          expect(runner.options.bucket).to eql bucket_name
+          expect(runner.options.config_hash).to include(bucket: bucket_name)
+        end
+      end
+    end
+
+    ["--max-age=VALUE"].each do |switch|
+      context switch do
+        let :max_age do
+          300
+        end
+
+        let :command do
+          switch.gsub(/VALUE/, max_age.to_s)
+        end
+
+        it "configures the max-age" do
+          allow(runner).to receive(:argv).and_return([command])
+          allow(runner).to receive(:log)
+          subject.parse!
+          expect(runner.options.config_hash).to include(max_age: max_age)
         end
       end
     end

data/spec/lib/nightcrawler_swift/cli/runner_spec.rb

@@ -101,7 +101,7 @@ describe NightcrawlerSwift::CLI::Runner do
     end
 
     it "configures NightcrawlerSwift" do
-      expect(NightcrawlerSwift).to receive(:configure).with opts
+      expect(NightcrawlerSwift).to receive(:configure).with opts.symbolize_keys
       subject.run
     end
 
@@ -121,16 +121,31 @@ describe NightcrawlerSwift::CLI::Runner do
 
       before do
         subject.send :configure_default_options
-        expect(subject.options.bucket).to be_nil
+        expect(subject.options.config_hash).to eql({})
       end
 
       it "overrides the default name" do
-        allow(subject).to receive(:parse_parameters) { subject.options.bucket = bucket_name }
+        allow(subject).to receive(:parse_parameters) { subject.options.config_hash[:bucket] = bucket_name }
         subject.run
         expect(NightcrawlerSwift.options.bucket).to eql bucket_name
       end
     end
 
+    context "with a custom max-age" do
+      let(:max_age) { 300 }
+
+      before do
+        subject.send :configure_default_options
+        expect(subject.options.config_hash).to eql({})
+      end
+
+      it "overrides the default name" do
+        allow(subject).to receive(:parse_parameters) { subject.options.config_hash[:max_age] = max_age }
+        subject.run
+        expect(NightcrawlerSwift.options.max_age).to eql max_age
+      end
+    end
+
     it "writes the auth_response into cache file" do
       expect(File.exist?(cache_file)).to eql false
       expect(connection).to receive(:auth_response).and_return(OpenStruct.new(connection_success_json))

data/spec/lib/nightcrawler_swift/command_spec.rb

@@ -60,14 +60,24 @@ describe NightcrawlerSwift::Command do
 
   describe "#get" do
     let :execute_http do
-      subject.send :get, url, headers: {content_type: :json}
+      subject.send :get, url, body: 'ignore_me', headers: { content_type: :json }, params: { b: 2 }
     end
 
     it_behaves_like "command with configured gateway"
 
+    it "ignores body" do
+      execute_http
+      expect(restclient).to have_received(:get).with(kind_of(Hash))
+    end
+
     it "sends headers with token" do
       execute_http
-      expect(restclient).to have_received(:get).with(content_type: :json, "X-Storage-Token" => token)
+      expect(restclient).to have_received(:get).with(hash_including({ content_type: :json, "X-Storage-Token" => token }))
+    end
+
+    it "sends params" do
+      execute_http
+      expect(restclient).to have_received(:get).with(hash_including(params: { b: 2 }))
     end
 
     it "returns RestClient response" do
@@ -77,14 +87,24 @@ describe NightcrawlerSwift::Command do
 
   describe "#delete" do
     let :execute_http do
-      subject.send :delete, url, headers: {content_type: :json}
+      subject.send :delete, url, body: 'ignore_me', headers: { content_type: :json }, params: { b: 2 }
     end
 
     it_behaves_like "command with configured gateway"
 
+    it "ignores body" do
+      execute_http
+      expect(restclient).to have_received(:delete).with(kind_of(Hash))
+    end
+
     it "sends headers with token" do
       execute_http
-      expect(restclient).to have_received(:delete).with(content_type: :json, "X-Storage-Token" => token)
+      expect(restclient).to have_received(:delete).with(hash_including({ content_type: :json, "X-Storage-Token" => token }))
+    end
+
+    it "sends params" do
+      execute_http
+      expect(restclient).to have_received(:delete).with(hash_including(params: { b: 2 }))
     end
 
     it "returns RestClient response" do
@@ -94,7 +114,7 @@ describe NightcrawlerSwift::Command do
 
   describe "#put" do
     let :execute_http do
-      subject.send(:put, url, body: 'content', headers: {a: 1})
+      subject.send :put, url, body: 'content', headers: { a: 1 }, params: { b: 2 }
     end
 
     it_behaves_like "command with configured gateway"
@@ -105,12 +125,17 @@ describe NightcrawlerSwift::Command do
 
     it "sends body" do
       execute_http
-      expect(restclient).to have_received(:put).with('content', anything)
+      expect(restclient).to have_received(:put).with('content', kind_of(Hash))
     end
 
     it "sends headers with token" do
       execute_http
-      expect(restclient).to have_received(:put).with(anything, {a: 1, "X-Storage-Token" => token})
+      expect(restclient).to have_received(:put).with(anything, hash_including({ a: 1, "X-Storage-Token" => token }))
+    end
+
+    it "sends params" do
+      execute_http
+      expect(restclient).to have_received(:put).with(anything, hash_including(params: { b: 2 }))
     end
   end
 

data/spec/lib/nightcrawler_swift/commands/download_spec.rb

@@ -5,7 +5,7 @@ describe NightcrawlerSwift::Download do
   let(:connection) { NightcrawlerSwift::Connection.new }
   let(:token) { "token" }
   let(:expires_at) { (DateTime.now + 60).to_time }
-  let(:public_url) { "server-url" }
+  let(:internal_url) { "server-url" }
   let(:bucket) { "rogue" }
 
   subject do
@@ -16,7 +16,7 @@ describe NightcrawlerSwift::Download do
     allow(NightcrawlerSwift).to receive(:connection).and_return(connection)
     allow(connection).to receive(:token_id).and_return(token)
     allow(connection).to receive(:expires_at).and_return(expires_at)
-    allow(connection).to receive(:public_url).and_return(public_url)
+    allow(connection).to receive(:internal_url).and_return(internal_url)
     NightcrawlerSwift.configure bucket: bucket
   end
 
@@ -34,7 +34,7 @@ describe NightcrawlerSwift::Download do
         allow(subject).to receive(:get).and_return(response)
       end
 
-      it "gets using public url" do
+      it "gets using internal url" do
         execute
         expect(subject).to have_received(:get).with("server-url/#{bucket}/file_path")
       end

data/spec/lib/nightcrawler_swift/commands/list_spec.rb

@@ -31,9 +31,19 @@ describe NightcrawlerSwift::List do
       allow(subject).to receive(:get).and_return(response)
     end
 
-    it "gets upload url" do
+    it "gets upload url without parameters" do
       subject.execute
-      expect(subject).to have_received(:get).with(connection.upload_url, headers: {accept: :json})
+      expect(subject).to have_received(:get).with(connection.upload_url, headers: { accept: :json }, params: {})
+    end
+
+    it "gets upload url with accepted parameters" do
+      subject.execute prefix: 'some/prefix', limit: 2
+      expect(subject).to have_received(:get).with(connection.upload_url, headers: { accept: :json }, params: { prefix: 'some/prefix', limit: 2 })
+    end
+
+    it "gets upload url without unknown parameters" do
+      subject.execute prefix: 'some/prefix', a: 'b'
+      expect(subject).to have_received(:get).with(connection.upload_url, headers: { accept: :json }, params: { prefix: 'some/prefix' })
     end
 
     it "returns the parsed json" do

data/spec/lib/nightcrawler_swift/commands/upload_spec.rb

@@ -68,10 +68,47 @@ describe NightcrawlerSwift::Upload do
       expect(subject).to have_received(:put).with("server-url/file_name", anything)
     end
 
-    it "sends max_age into headers" do
-      NightcrawlerSwift.configure max_age: max_age
-      execute
-      expect(subject).to have_received(:put).with(anything, hash_including(headers: { content_type: "text/css", etag: etag, cache_control: "public, max-age=#{max_age}" }))
+    context "max_age" do
+      let :default_headers do
+        {content_type: "text/css", etag: etag}
+      end
+
+      it "sends default max_age into headers" do
+        NightcrawlerSwift.configure max_age: max_age
+        execute
+        expect(subject).to have_received(:put).with(
+          anything,
+          hash_including(
+            headers: hash_including(default_headers.merge(cache_control: "public, max-age=#{max_age}"))
+          )
+        )
+      end
+
+      it "allows custom max_age" do
+        NightcrawlerSwift.configure
+        subject.execute path, file, max_age: 1
+        expect(subject).to have_received(:put).with(
+          anything,
+          hash_including(
+            headers: hash_including(default_headers.merge(cache_control: "public, max-age=1"))
+          )
+        )
+      end
+
+      it "also sends the expires header based on max_age" do
+        now = Time.now
+        allow(Time).to receive(:now).and_return(now)
+        expires = CGI.rfc1123_date(Time.now + max_age)
+
+        NightcrawlerSwift.configure max_age: max_age
+        execute
+        expect(subject).to have_received(:put).with(
+          anything,
+          hash_including(
+            headers: default_headers.merge(cache_control: "public, max-age=#{max_age}", expires:  expires)
+          )
+        )
+      end
     end
 
     context "when response code is 200" do

data/spec/lib/nightcrawler_swift/connection_spec.rb

@@ -97,6 +97,11 @@ describe NightcrawlerSwift::Connection do
         expect(subject.public_url).to eql(auth_success_json["access"]["serviceCatalog"].first["endpoints"].first["publicURL"])
       end
 
+      it "stores the internal_url" do
+        subject.connect!
+        expect(subject.internal_url).to eql(auth_success_json["access"]["serviceCatalog"].first["endpoints"].first["internalURL"])
+      end
+
       it "returns self" do
         expect(subject.connect!).to eql(subject)
       end

data/spec/lib/nightcrawler_swift/ext/hash_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe NightcrawlerSwift::Hash do
+
+  subject do
+    {"key1" => "value1", "key2" => "value2"}
+  end
+
+  describe "#symbolize_keys" do
+    it "creates a new hash with the symbolized keys" do
+      result = subject.symbolize_keys
+      expect(result).to include(key1: "value1", key2: "value2")
+      expect(subject).to include("key1" => "value1", "key2" => "value2")
+    end
+  end
+
+  describe "#symbolize_keys!" do
+    it "destructively convert all keys to symbols" do
+      result = subject.symbolize_keys!
+      expect(result).to include(key1: "value1", key2: "value2")
+      expect(subject).to include(key1: "value1", key2: "value2")
+      expect(result).to eql subject
+    end
+  end
+
+  describe "#compact" do
+    subject do
+      {key1: nil, key2: "value2", key3: nil}
+    end
+
+    it "creates a new hash without the nil items" do
+      result = subject.compact
+      expect(result).to_not include(:key1, :key3)
+      expect(result).to include(:key2)
+
+      expect(subject).to include(:key1, :key2, :key3)
+    end
+  end
+
+  describe "#compact!" do
+    subject do
+      {key1: nil, key2: "value2", key3: nil}
+    end
+
+    it "destructively remove the items with the nil value" do
+      result = subject.compact!
+      expect(result).to_not include(:key1, :key3)
+      expect(result).to include(:key2)
+      expect(subject).to_not include(:key1, :key3)
+      expect(subject).to include(:key2)
+
+      expect(result).to eql subject
+    end
+  end
+
+end

data/spec/lib/nightcrawler_swift/gateway_spec.rb

@@ -10,12 +10,16 @@ describe NightcrawlerSwift::Gateway do
     subject.request {|r| r.get}
   end
 
+  let :opts do
+    {}
+  end
+
   subject do
     NightcrawlerSwift::Gateway.new url
   end
 
   before do
-    NightcrawlerSwift.configure
+    NightcrawlerSwift.configure opts
   end
 
   describe "initialization" do
@@ -27,6 +31,79 @@ describe NightcrawlerSwift::Gateway do
       )
       subject
     end
+
+    context "with ssl options" do
+      context "but only 'ssl_client_cert'" do
+        let :opts do
+          {verify_ssl: true, ssl_client_cert: "somecert.pem"}
+        end
+
+        it "uses the configured option" do
+          expect(RestClient::Resource).to receive(:new).with(
+            url,
+            timeout: NightcrawlerSwift.options.timeout,
+            verify_ssl: NightcrawlerSwift.options.verify_ssl,
+            ssl_client_cert: NightcrawlerSwift.options.ssl_client_cert
+          )
+          subject
+        end
+      end
+
+      context "but only 'ssl_client_key'" do
+        let :opts do
+          {verify_ssl: true, ssl_client_key: "clientkey"}
+        end
+
+        it "uses the configured option" do
+          expect(RestClient::Resource).to receive(:new).with(
+            url,
+            timeout: NightcrawlerSwift.options.timeout,
+            verify_ssl: NightcrawlerSwift.options.verify_ssl,
+            ssl_client_key: NightcrawlerSwift.options.ssl_client_key
+          )
+          subject
+        end
+      end
+
+      context "but only 'ssl_ca_file'" do
+        let :opts do
+          {verify_ssl: true, ssl_ca_file: "Certificate Authority File"}
+        end
+
+        it "uses the configured option" do
+          expect(RestClient::Resource).to receive(:new).with(
+            url,
+            timeout: NightcrawlerSwift.options.timeout,
+            verify_ssl: NightcrawlerSwift.options.verify_ssl,
+            ssl_ca_file: NightcrawlerSwift.options.ssl_ca_file
+          )
+          subject
+        end
+      end
+
+      context "using all options" do
+        let :opts do
+          {
+            verify_ssl: true,
+            ssl_client_cert: "somecert.pem",
+            ssl_client_key: "clientkey",
+            ssl_ca_file: "Certificate Authority File"
+          }
+        end
+
+        it "uses the configured options" do
+          expect(RestClient::Resource).to receive(:new).with(
+            url,
+            timeout: NightcrawlerSwift.options.timeout,
+            verify_ssl: NightcrawlerSwift.options.verify_ssl,
+            ssl_client_cert: NightcrawlerSwift.options.ssl_client_cert,
+            ssl_client_key: NightcrawlerSwift.options.ssl_client_key,
+            ssl_ca_file: NightcrawlerSwift.options.ssl_ca_file
+          )
+          subject
+        end
+      end
+    end
   end
 
   describe "#request" do

data/spec/lib/nightcrawler_swift/options_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe NightcrawlerSwift::Options do
+
+  subject do
+    NightcrawlerSwift::Options.new opts
+  end
+
+  let :opts do
+    {}
+  end
+
+  describe "initialization" do
+    context "verify_ssl" do
+      it "defauts to false" do
+        expect(subject.verify_ssl).to eql false
+      end
+    end
+
+    context "retries" do
+      it "defauts to 5" do
+        expect(subject.retries).to eql 5
+      end
+    end
+
+    context "max_retry_time" do
+      it "defauts to 30" do
+        expect(subject.max_retry_time).to eql 30
+      end
+    end
+
+    context "password" do
+      before do
+        expect(ENV).to receive(:[]).with("NSWIFT_PASSWORD").and_return("123")
+      end
+
+      it "can be defined by the ENV variable 'NSWIFT_PASSWORD'" do
+        expect(subject.password).to eql "123"
+      end
+
+      context "when configured" do
+        let :opts do
+          {password: "345"}
+        end
+
+        it "takes the ENV variable in precedence" do
+          expect(subject.password).to eql "123"
+        end
+      end
+    end
+
+    context "and max_age isn't an integer" do
+      let(:opts) { {max_age: "a string"} }
+
+      it "raises NightcrawlerSwift::Exceptions::ConfigurationError" do
+        expect { subject }.to raise_error(NightcrawlerSwift::Exceptions::ConfigurationError)
+      end
+    end
+
+    context "when configured" do
+      let :opts do
+        {
+          bucket: "rogue",
+          password: "123",
+          retries: 2
+        }
+      end
+
+      it "creates with the given values" do
+        expect(subject.bucket).to eql "rogue"
+        expect(subject.password).to eql "123"
+        expect(subject.retries).to eql 2
+      end
+    end
+  end
+
+end

data/spec/lib/nightcrawler_swift_spec.rb

@@ -29,7 +29,7 @@ describe NightcrawlerSwift do
   end
 
   describe "::configure" do
-    it "creates the options struct with the given values" do
+    it "creates the options with the given values" do
       subject.configure opts
       expect(subject.options).to_not be_nil
       opts.keys.each do |key|
@@ -42,32 +42,6 @@ describe NightcrawlerSwift do
       subject.configure opts
       expect(subject.connection).to_not be_nil
     end
-
-    context "verify_ssl" do
-      it "defauts to false" do
-        expect(subject.options.verify_ssl).to eql false
-      end
-    end
-
-    context "retries" do
-      it "defauts to 5" do
-        expect(subject.options.retries).to eql 5
-      end
-    end
-
-    context "max_retry_time" do
-      it "defauts to 30" do
-        expect(subject.options.max_retry_time).to eql 30
-      end
-    end
-
-    context "and max_age isn't an integer" do
-      let(:opts) { {max_age: "a string"} }
-
-      it "raises NightcrawlerSwift::Exceptions::ConfigurationError" do
-        expect { subject.configure(opts) }.to raise_error(NightcrawlerSwift::Exceptions::ConfigurationError)
-      end
-    end
   end
 
   describe "::connection" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nightcrawler_swift
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - tulios
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -145,7 +145,9 @@ files:
 - lib/nightcrawler_swift/commands/upload.rb
 - lib/nightcrawler_swift/connection.rb
 - lib/nightcrawler_swift/exceptions.rb
+- lib/nightcrawler_swift/ext/hash.rb
 - lib/nightcrawler_swift/gateway.rb
+- lib/nightcrawler_swift/options.rb
 - lib/nightcrawler_swift/railtie.rb
 - lib/nightcrawler_swift/tasks/asset_sync.rake
 - lib/nightcrawler_swift/version.rb
@@ -167,7 +169,9 @@ files:
 - spec/lib/nightcrawler_swift/commands/sync_spec.rb
 - spec/lib/nightcrawler_swift/commands/upload_spec.rb
 - spec/lib/nightcrawler_swift/connection_spec.rb
+- spec/lib/nightcrawler_swift/ext/hash_spec.rb
 - spec/lib/nightcrawler_swift/gateway_spec.rb
+- spec/lib/nightcrawler_swift/options_spec.rb
 - spec/lib/nightcrawler_swift/tasks/asset_sync_spec.rb
 - spec/lib/nightcrawler_swift_spec.rb
 - spec/spec_helper.rb
@@ -214,7 +218,9 @@ test_files:
 - spec/lib/nightcrawler_swift/commands/sync_spec.rb
 - spec/lib/nightcrawler_swift/commands/upload_spec.rb
 - spec/lib/nightcrawler_swift/connection_spec.rb
+- spec/lib/nightcrawler_swift/ext/hash_spec.rb
 - spec/lib/nightcrawler_swift/gateway_spec.rb
+- spec/lib/nightcrawler_swift/options_spec.rb
 - spec/lib/nightcrawler_swift/tasks/asset_sync_spec.rb
 - spec/lib/nightcrawler_swift_spec.rb
 - spec/spec_helper.rb