nightcrawler_swift 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8ecba7c2f2eb54d05e60faf6f646e86f3cbabd6
-  data.tar.gz: 90002c61b8d4980170bda37ba8350a215e016917
+  metadata.gz: 792e1b2a4c65b85291d7a5c733fbd238f6b4f531
+  data.tar.gz: b34fa251f341f191b7627d8ac200bb0daa43fdbd
 SHA512:
-  metadata.gz: 59ac7d43fb910a23e5f8b5cc79ae674c32f64001e9d013055c289c1ad0c85af24fee8a638584080330c804e7322dbe6d603b17f8a30a7e52e5bffe0e40696e45
-  data.tar.gz: d9d997b31878e5552c8c1128135a9f7a620df7a4038814f72bbe4f46a6d536ebafdb192e9f3cffefd54b72cbbc49fd91341fb9dbd682419c7b25289d6acc9a1d
+  metadata.gz: be4f048df14fe2453b4fc22ed8e495434c5f4fb51009f8e5765fae6f61cbc160dcf12ae4c2d274e4aa69096884b629d8e83538f03bd14dd4992ad39dc1e66f91
+  data.tar.gz: d9bd21e55c32c1ee73f16e817c7edf2c529552d94402c615a63a37026f01eb5ba477b21c461878f35fcd54953e574553dda79e5ce6f50cf5b745e61ad55030a7

data/.gitignore

@@ -1 +1,2 @@
 .DS_Store
+pkg

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+script: bundle exec rspec

data/Changelog.md

@@ -0,0 +1,34 @@
+# Changelog
+
+## 0.3.0
+
+  - Included ```Cache-Control``` header to upload command through max_age configuration parameter
+  - Sending etag when uploading assets
+  - Bugfix: rake task now returns exit code 1 when error
+
+## 0.2.3
+
+  - Removed rest-client version due to compatibility issues
+
+## 0.2.2
+
+  - Included ```Content-Type``` header to upload command
+
+## 0.2.1
+
+  - Bugfix: sync was not connecting
+
+## 0.2.0
+
+  - Better Rails integration
+  - Download command
+
+## 0.1.1
+
+  - Bugfix: sync broken syntax
+
+## 0.1.0
+
+  - Connection object
+  - Sync, upload, delete and list commands
+  - Rake task to sync Rails public dir

data/Gemfile.lock

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

data/README.md

@@ -1,5 +1,6 @@
 [![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
 
 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.
@@ -21,17 +22,19 @@ Or install it yourself as:
 ## Usage
 
 ### With Rails
-#### 1) Configure your swift credentials
+#### 1) Configure your swift credentials and options
 
 _In config/application.rb_ or _config/environments/*.rb_
 
 ```ruby
 config.nightcrawler_swift.bucket = "rogue"
-config.nightcrawler_swift.tenent_name = "nightcrawler"
+config.nightcrawler_swift.tenant_name = "nightcrawler"
 config.nightcrawler_swift.username = "my_username1"
 config.nightcrawler_swift.password = "my_password1"
 config.nightcrawler_swift.auth_url = "https://auth.url.com:123/v2.0/tokens"
+config.nightcrawler_swift.max_age = 3600 #optional
 ```
+**max_age** will be used to define *Cache-Control:max-age=<value>* header. It's not required.
 
 By default it will use ```Rails.logger``` as logger, to change that use a different logger in configurations, like:
 
@@ -49,7 +52,7 @@ It will invoke ```rake assets:precompile``` and will copy your public directory
 
 ### Programatically
 
-#### 1) Configure your swift credentials
+#### 1) Configure your swift credentials and options
 
 ```ruby
 NightcrawlerSwift.configure({
@@ -57,7 +60,8 @@ NightcrawlerSwift.configure({
   tenant_name: "nightcrawler"
   username: "my_username1",
   password: "my_password1",
-  auth_url: "https://auth.url.com:123/v2.0/tokens"
+  auth_url: "https://auth.url.com:123/v2.0/tokens",
+  max_age: 3600 #optional
 })
 ```
 

data/lib/nightcrawler_swift/connection.rb

@@ -6,6 +6,7 @@ module NightcrawlerSwift
     #
     def initialize opts = {}
       @opts = OpenStruct.new opts
+      raise NightcrawlerSwift::Exceptions::ConfigurationError.new "max_age should be an Integer" if @opts.max_age and not @opts.max_age.is_a? Numeric
     end
 
     def connect!

data/lib/nightcrawler_swift/exceptions.rb

@@ -12,6 +12,6 @@ module NightcrawlerSwift
 
     class ConnectionError < BaseError; end
     class NotFoundError < BaseError; end
-
+    class ConfigurationError < StandardError; end
   end
 end

data/lib/nightcrawler_swift/tasks/asset_sync.rake

@@ -5,8 +5,12 @@ namespace :nightcrawler_swift do
 
     desc "Synchronizes the public directory with OpenStack Swift"
     task asset_sync: ["assets:precompile", "environment"] do
-      raise unless defined?(Rails)
-      NightcrawlerSwift.sync File.join(Rails.root, "public")
+      begin
+        NightcrawlerSwift.sync File.join(Rails.root, "public")
+      rescue => e
+        STDERR.puts e.message
+        exit 1
+      end
     end
 
   end

data/lib/nightcrawler_swift/upload.rb

@@ -1,9 +1,15 @@
+require 'digest'
+
 module NightcrawlerSwift
   class Upload < Command
 
     def execute path, file
       content_type = MultiMime.by_file(file).content_type
-      response = put "#{connection.upload_url}/#{path}", body: file.read, headers: {content_type: content_type}
+      content = file.read
+      etag = '"%s"' % Digest::MD5.new.update(content).hexdigest
+      headers = {etag: etag, content_type: content_type}
+      headers.merge!({cache_control: "max-age=#{connection.opts.max_age}"}) if connection.opts.max_age
+      response = put "#{connection.upload_url}/#{path}", body: content, headers: headers
       [200, 201].include?(response.code)
     end
 

data/lib/nightcrawler_swift/version.rb

@@ -1,3 +1,3 @@
 module NightcrawlerSwift
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/spec/lib/nightcrawler_swift/connection_spec.rb

@@ -8,7 +8,8 @@ describe NightcrawlerSwift::Connection do
       tenant_name: "tenant_username1",
       username: "username1",
       password: "some-pass",
-      auth_url: "https://auth.url.com:123/v2.0/tokens"
+      auth_url: "https://auth.url.com:123/v2.0/tokens",
+      max_age: 31536000 #1 year
     }
   end
 
@@ -89,6 +90,16 @@ describe NightcrawlerSwift::Connection do
       it "returns self" do
         expect(subject.connect!).to eql(subject)
       end
+
+      context "max_age" do
+        it "stores it" do
+          expect(subject.opts.max_age).to eql(opts[:max_age])
+        end
+
+        it "should be an integer" do
+          expect { NightcrawlerSwift::Connection.new({max_age: "a string"}) }.to raise_error(NightcrawlerSwift::Exceptions::ConfigurationError)
+        end
+      end
     end
 
     describe "when some error happens" do

data/spec/lib/nightcrawler_swift/tasks/asset_sync_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+unless defined?(Rails)
+  module Rails
+    def self.root; end
+  end
+end
+
+describe "asset_sync.rake" do
+  let :rake do
+    Rake.application = Rake::Application.new
+  end
+
+  let :load_path do
+    [File.expand_path(File.join(File.dirname(__FILE__), "../../../../lib/nightcrawler_swift/tasks"))]
+  end
+
+  before do
+    rake.rake_require "asset_sync", load_path, []
+
+    Rake::Task.define_task("environment")
+    Rake::Task.define_task("assets:precompile")
+  end
+
+  describe "nightcrawler_swift:rails:asset_sync" do
+    let(:task_name) { "nightcrawler_swift:rails:asset_sync" }
+    subject { rake[task_name] }
+
+    before do
+      allow(Rails).to receive(:root).and_return(".")
+    end
+
+    it "requires environment and assets:precompile" do
+      expect(subject.prerequisites).to include "environment"
+      expect(subject.prerequisites).to include "assets:precompile"
+    end
+
+    it "calls sync with Rails public dir path" do
+      expect(NightcrawlerSwift).to receive(:sync).with("./public")
+      subject.invoke
+    end
+
+    context "when occurs an error" do
+      it "exits with code 1" do
+        allow(STDERR).to receive(:puts)
+        allow(NightcrawlerSwift).to receive(:sync).and_raise(StandardError.new)
+        code = "wrong code"
+
+        begin
+          subject.invoke
+        rescue SystemExit => e
+          code = e.status
+        end
+
+        expect(code).to eql(1)
+      end
+    end
+  end
+end

data/spec/lib/nightcrawler_swift/upload_spec.rb

@@ -1,3 +1,4 @@
+require 'digest'
 require 'spec_helper'
 
 describe NightcrawlerSwift::Upload do
@@ -14,13 +15,21 @@ describe NightcrawlerSwift::Upload do
     end
 
     let :connection do
-      double :connection, upload_url: "server-url"
+      double :connection, upload_url: "server-url", opts: OpenStruct.new {}
     end
 
     let :response do
       double(:response, code: 201)
     end
 
+    let :etag do
+      '"%s"' % Digest::MD5.new.update(file.read).hexdigest
+    end
+
+    let :max_age do
+      31536000
+    end
+
     before do
       allow(NightcrawlerSwift).to receive(:connection).and_return(connection)
       allow(subject).to receive(:put).and_return(response)
@@ -41,9 +50,9 @@ describe NightcrawlerSwift::Upload do
       expect(subject).to have_received(:put).with(anything, hash_including(body: "content"))
     end
 
-    it "sends file content_type as header" do
+    it "sends file metadata as headers" do
       execute
-      expect(subject).to have_received(:put).with(anything, hash_including(headers: { content_type: "text/css"}))
+      expect(subject).to have_received(:put).with(anything, hash_including(headers: { content_type: "text/css", etag: etag}))
     end
 
     it "sends to upload url with given path" do
@@ -51,6 +60,12 @@ describe NightcrawlerSwift::Upload do
       expect(subject).to have_received(:put).with("server-url/file_name", anything)
     end
 
+    it "sends max_age into headers" do
+      connection.opts.max_age = max_age
+      execute
+      expect(subject).to have_received(:put).with(anything, hash_including(headers: { content_type: "text/css", etag: etag, cache_control: "max-age=#{max_age}" }))
+    end
+
     context "when response code is 200" do
       let(:response) { double(:response, code: 200) }
       it { expect(execute).to be true }

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require "rake"
 require "byebug"
 require "nightcrawler_swift"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nightcrawler_swift
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - tulios
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -108,6 +108,8 @@ files:
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
+- Changelog.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -138,6 +140,7 @@ files:
 - spec/lib/nightcrawler_swift/download_spec.rb
 - spec/lib/nightcrawler_swift/list_spec.rb
 - spec/lib/nightcrawler_swift/sync_spec.rb
+- spec/lib/nightcrawler_swift/tasks/asset_sync_spec.rb
 - spec/lib/nightcrawler_swift/upload_spec.rb
 - spec/lib/nightcrawler_swift_spec.rb
 - spec/spec_helper.rb
@@ -179,6 +182,7 @@ test_files:
 - spec/lib/nightcrawler_swift/download_spec.rb
 - spec/lib/nightcrawler_swift/list_spec.rb
 - spec/lib/nightcrawler_swift/sync_spec.rb
+- spec/lib/nightcrawler_swift/tasks/asset_sync_spec.rb
 - spec/lib/nightcrawler_swift/upload_spec.rb
 - spec/lib/nightcrawler_swift_spec.rb
 - spec/spec_helper.rb