nightcrawler_swift 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6210245e5388c7b1c73fa1c6ff58b2f7a2770320
-  data.tar.gz: 6071b7124b88f4293ea186b2755c99a7e6f3b407
+  metadata.gz: e8ef6b380623f8ce83cfea1491c10c44bfc8ed04
+  data.tar.gz: 9df2abbd80c6f1fceedf2dddc58d59be45e33520
 SHA512:
-  metadata.gz: 65753c810f8691b5e06afe0db034d692ac9187d7d73e5b3be899a141fd1ffe3eb86114ebb2bcd4c6ebdffadc8760905a9a04d6da93a677f6c3db7a116824ee48
-  data.tar.gz: bd9c1a5bbc7dffd4e24c0d8efab7e50f0e8917af973b4b9798e2d9df14b9f61793d1414d196df03b292b6758e431a50c6b3913d22c5fbb198617d2492c587674
+  metadata.gz: 8fdf97c07f42e76d5b83941b2f95d8cb32270bba360369c0b28547a25151ad56290aad0ea5ecfb076d1c012fb5abf4a331c579f216ed815dd342f9f5addf97d5
+  data.tar.gz: 9f2d5e258abc3f309cc57759a81938041ddf8ec49111276e3b4ee3bf6120edf527c875a01715b28a030aa970c508d5dbbfb185d702dd2d354e068cba11d6eff3

data/Changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.7.0
+
+  - CLI now supports ```--no-cache``` which ignores the cached connection and removes the cache file if it exists (issue #12)
+  - Bugfix: invalidate nswift_cache when the connection fail (issue #27)
+  - Bugfix: OpenStruct in Ruby 1.9.x doesn't have the method [], using 'send' instead
+  - Bugfix: OpenStruct and nil doesn't have the method to_h in Ruby 1.9.x
+
 ## 0.6.0
 
   - Upload command allows a custom max-age (issue #23)

data/Gemfile.lock

@@ -1,26 +1,27 @@
 PATH
   remote: .
   specs:
-    nightcrawler_swift (0.6.0)
+    nightcrawler_swift (0.7.0)
       multi_mime (>= 1.0.1)
       rest-client
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (3.2.0)
+    byebug (3.5.1)
       columnize (~> 0.8)
       debugger-linecache (~> 1.2)
+      slop (~> 3.6)
     codeclimate-test-reporter (0.4.0)
       simplecov (>= 0.7.1, < 1.0.0)
-    columnize (0.8.9)
+    columnize (0.9.0)
     debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    mime-types (2.3)
+    mime-types (2.4.3)
     multi_json (1.10.1)
     multi_mime (1.0.1)
-    netrc (0.7.7)
+    netrc (0.10.2)
     rake (10.3.2)
     rest-client (1.7.2)
       mime-types (>= 1.16, < 3.0)
@@ -42,6 +43,7 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
+    slop (3.6.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,4 +1,4 @@
-# Nightcrawler Swift [![Code Climate](https://codeclimate.com/github/tulios/nightcrawler_swift/badges/gpa.svg)](https://codeclimate.com/github/tulios/nightcrawler_swift) [![Travis](https://api.travis-ci.org/tulios/nightcrawler_swift.svg?branch=master)](https://travis-ci.org/tulios/nightcrawler_swift) [![Gem Version](https://badge.fury.io/rb/nightcrawler_swift.svg)](http://badge.fury.io/rb/nightcrawler_swift)
+# Nightcrawler Swift [![Gem Version](https://badge.fury.io/rb/nightcrawler_swift.svg)](http://badge.fury.io/rb/nightcrawler_swift) [![Code Climate](https://codeclimate.com/github/tulios/nightcrawler_swift/badges/gpa.svg)](https://codeclimate.com/github/tulios/nightcrawler_swift) [![Travis](https://api.travis-ci.org/tulios/nightcrawler_swift.svg?branch=master)](https://travis-ci.org/tulios/nightcrawler_swift)
 
 Like the X-Men nightcrawler this gem teleports your assets to a OpenStack Swift bucket/container. It was designed to sync your assets with OpenStack Swift and allow some operations with your buckets/containers.
 

data/lib/nightcrawler_swift/cli/opt_parser.rb

@@ -36,6 +36,7 @@ module NightcrawlerSwift::CLI
       configure_option_bucket
       configure_option_max_age
       configure_option_config
+      configure_option_no_cache
       configure_option_help
       configure_option_version
     end
@@ -73,6 +74,12 @@ module NightcrawlerSwift::CLI
       end
     end
 
+    def configure_option_no_cache
+      @parser.on_tail("--no-cache", "Avoids the connection cache. It also clears the cache if it exists") do
+        @runner.options.use_cache = false
+      end
+    end
+
     def configure_option_help
       @parser.on_tail("-h", "--help", "Show this message") do
         @runner.log help

data/lib/nightcrawler_swift/cli/runner.rb

@@ -33,6 +33,7 @@ module NightcrawlerSwift::CLI
       @options.configured = true
       @options.default_config_file = true
       @options.config_file = File.expand_path(File.join(user_home_dir, CONFIG_FILE))
+      @options.use_cache = true
       @options.cache_file = File.expand_path(File.join(user_home_dir, CACHE_FILE))
       @options.config_hash = {}
     end
@@ -79,23 +80,34 @@ module NightcrawlerSwift::CLI
     def connect_and_execute &block
       path = options.cache_file
       if File.exist?(path)
-        hash = JSON.parse File.read(path)
-        NightcrawlerSwift.connection.auth_response = OpenStruct.new(hash)
-        NightcrawlerSwift.connection.configure
-
-        token_id = NightcrawlerSwift.connection.token_id
-        NightcrawlerSwift.logger.debug "Cache found, restablishing connection with token_id: #{token_id}"
+        @options.use_cache ? restore_connection(path) : File.delete(path)
       end
 
       begin
         block.call
       ensure
+        return unless @options.use_cache
         File.open(path, "w") do |f|
           f.write(NightcrawlerSwift.connection.auth_response.to_h.to_json)
         end
       end
     end
 
+    def restore_connection cache_path
+      begin
+        hash = JSON.parse File.read(cache_path)
+        NightcrawlerSwift.connection.auth_response = OpenStruct.new(hash)
+        NightcrawlerSwift.connection.configure
+
+        token_id = NightcrawlerSwift.connection.token_id
+        NightcrawlerSwift.logger.debug "Cache found, restablishing connection with token_id: #{token_id}"
+
+      rescue
+        log "Failed to restore connection, removing cache"
+        File.delete cache_path
+      end
+    end
+
     def parse_parameters
       @opt_parser.parse!
       check_rcfile if options.default_config_file

data/lib/nightcrawler_swift/ext/hash.rb

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

data/lib/nightcrawler_swift/ext/nil_class.rb

@@ -0,0 +1,15 @@
+module NightcrawlerSwift
+  module Ext
+    module NilClass
+
+      unless nil.respond_to?(:to_h)
+        def to_h
+          {}
+        end
+      end
+
+    end
+  end
+end
+
+NilClass.send :include, NightcrawlerSwift::Ext::NilClass

data/lib/nightcrawler_swift/ext/open_struct.rb

@@ -0,0 +1,15 @@
+module NightcrawlerSwift
+  module Ext
+    module OpenStruct
+
+      unless ::OpenStruct.new.respond_to?(:to_h)
+        def to_h
+          @table.dup || {}
+        end
+      end
+
+    end
+  end
+end
+
+OpenStruct.send :include, NightcrawlerSwift::Ext::OpenStruct

data/lib/nightcrawler_swift/gateway.rb

@@ -62,7 +62,10 @@ module NightcrawlerSwift
         :ssl_ca_file
 
       ].inject({}) {|hash, key|
-        hash.tap {hash[key] = options[key]}
+        hash.tap {
+          # OpenStruct in Ruby 1.9.x doesn't have the method []
+          hash[key] = options.send(key)
+        }
       }.compact
     end
 

data/lib/nightcrawler_swift/version.rb

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

data/lib/nightcrawler_swift.rb

@@ -8,6 +8,8 @@ require "rest_client"
 require "nightcrawler_swift/version"
 require "nightcrawler_swift/exceptions"
 require "nightcrawler_swift/ext/hash"
+require "nightcrawler_swift/ext/open_struct"
+require "nightcrawler_swift/ext/nil_class"
 require "nightcrawler_swift/options"
 require "nightcrawler_swift/gateway"
 require "nightcrawler_swift/connection"

data/nightcrawler_swift.gemspec

@@ -25,5 +25,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "codeclimate-test-reporter"
-  spec.add_development_dependency "byebug"
+
+  if RUBY_VERSION =~ /1\.9/
+    spec.add_development_dependency "debugger"
+  else
+    spec.add_development_dependency "byebug"
+  end
 end

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

@@ -131,6 +131,16 @@ describe NightcrawlerSwift::CLI::OptParser do
         end
       end
     end
+
+    ["--no-cache"].each do |switch|
+      context switch do
+        it "configures use_cache with false" do
+          allow(runner).to receive(:argv).and_return([switch])
+          subject.parse!
+          expect(runner.options.use_cache).to eql false
+        end
+      end
+    end
   end
 
   describe "#parse!" do

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

@@ -63,7 +63,12 @@ describe NightcrawlerSwift::CLI::Runner do
       expect(subject.options.config_file).to eql File.expand_path(path)
     end
 
-    it "points to a cache file in the uder home dir" do
+    it "enables the use of cache" do
+      subject.run
+      expect(subject.options.use_cache).to eql true
+    end
+
+    it "points to a cache file in the user home dir" do
       subject.run
       path = File.join(config_dir, NightcrawlerSwift::CLI::CACHE_FILE)
       expect(subject.options.cache_file).to eql File.expand_path(path)
@@ -112,7 +117,9 @@ describe NightcrawlerSwift::CLI::Runner do
 
         expect(connection).to receive(:configure).and_call_original
         subject.run
-        expect(connection.auth_response).to eql(OpenStruct.new(connection_success_json))
+        # This test uses 'eq' instead of 'eql' because in Ruby 1.9.x the method
+        # 'equal?' is different than '==' making this test fail
+        expect(connection.auth_response).to eq(OpenStruct.new(connection_success_json))
       end
     end
 
@@ -146,6 +153,30 @@ describe NightcrawlerSwift::CLI::Runner do
       end
     end
 
+    context "with no-cache flag" do
+      before do
+        subject.send :configure_default_options
+        expect(subject.options.use_cache).to eql true
+        allow(subject).to receive(:parse_parameters) { subject.options.use_cache = false }
+      end
+
+      it "doesn't write the auth_response into cache file" do
+        expect(File.exist?(cache_file)).to eql false
+        allow(connection).to receive(:auth_response).and_return(OpenStruct.new(connection_success_json))
+        subject.run
+        expect(File.exist?(cache_file)).to eql false
+      end
+
+      it "removes the cache file if it exists" do
+        expect(File.exist?(cache_file)).to eql false
+        allow(connection).to receive(:auth_response).and_return(OpenStruct.new(connection_success_json))
+        File.open(cache_file, "w") {|f| f.write(connection_success_json.to_json)}
+        expect(File.exist?(cache_file)).to eql true
+        subject.run
+        expect(File.exist?(cache_file)).to eql false
+      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))
@@ -176,6 +207,18 @@ describe NightcrawlerSwift::CLI::Runner do
       end
     end
 
+    context "when there is an error with connection cache" do
+      it "removes the cache file if it exists and allows the creation of a new one" do
+        expect(File.exist?(cache_file)).to eql false
+        allow(connection).to receive(:auth_response).and_return(OpenStruct.new(connection_success_json))
+        File.open(cache_file, "w") {|f| f.write("null")}
+        expect(File.exist?(cache_file)).to eql true
+        subject.run
+        expect(File.exist?(cache_file)).to eql true
+        expect(File.read(cache_file)).to eql connection_success_json.to_json
+      end
+    end
+
     context "when rescue Errno::ENOENT" do
       before do
         NightcrawlerSwift.logger = Logger.new(StringIO.new)

data/spec/lib/nightcrawler_swift/connection_spec.rb

@@ -63,7 +63,9 @@ describe NightcrawlerSwift::Connection do
 
       it "stores the auth_response" do
         subject.connect!
-        expect(subject.auth_response).to eql(OpenStruct.new(auth_success_json))
+        # This test uses 'eq' instead of 'eql' because in Ruby 1.9.x the method
+        # 'equal?' is different than '==' making this test fail
+        expect(subject.auth_response).to eq(OpenStruct.new(auth_success_json))
       end
 
       it "stores the token id" do

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

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe NightcrawlerSwift::Hash do
+describe NightcrawlerSwift::Ext::Hash do
 
   subject do
     {"key1" => "value1", "key2" => "value2"}

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

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe NightcrawlerSwift::Ext::NilClass do
+
+  subject do
+    nil
+  end
+
+  describe "#to_h" do
+    it "always returns an empty hash" do
+      expect(subject.to_h).to eql({})
+    end
+  end
+
+end

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe NightcrawlerSwift::Ext::OpenStruct do
+
+  let :hash do
+    {key1: "value", key2: true}
+  end
+
+  subject do
+    OpenStruct.new hash
+  end
+
+  describe "#to_h" do
+    it "returns a hash with the content" do
+      expect(subject.to_h).to eql hash
+    end
+
+    describe "for a blank object" do
+      subject do
+        OpenStruct.new
+      end
+
+      it "returns an empty hash" do
+        expect(subject.to_h).to eql({})
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 
 require "rake"
-require "byebug"
+RUBY_VERSION =~ /1\.9/ ? require("debugger") : require("byebug")
 require "nightcrawler_swift"
 
 # This file was generated by the `rspec --init` command. Conventionally, all

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nightcrawler_swift
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - tulios
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -146,6 +146,8 @@ files:
 - lib/nightcrawler_swift/connection.rb
 - lib/nightcrawler_swift/exceptions.rb
 - lib/nightcrawler_swift/ext/hash.rb
+- lib/nightcrawler_swift/ext/nil_class.rb
+- lib/nightcrawler_swift/ext/open_struct.rb
 - lib/nightcrawler_swift/gateway.rb
 - lib/nightcrawler_swift/options.rb
 - lib/nightcrawler_swift/railtie.rb
@@ -170,6 +172,8 @@ files:
 - 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/ext/nil_class_spec.rb
+- spec/lib/nightcrawler_swift/ext/open_struct_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
@@ -219,6 +223,8 @@ test_files:
 - 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/ext/nil_class_spec.rb
+- spec/lib/nightcrawler_swift/ext/open_struct_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