nightcrawler_swift 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79434fd33fdd1553c96cfe7964b9b70dac81f9a2
-  data.tar.gz: 70ea95d04f973e6cd967a18cc23e4ee4b3c63dfa
+  metadata.gz: 45a3c84d56e90690626dab9281b98746d80d2d1a
+  data.tar.gz: 9def0f86a48fb9c2d55d5404dff9f2128b9534e5
 SHA512:
-  metadata.gz: 56e368d00cafc9d95b2245d801331f56387a78d6d3b4a91a7c0bd66efdbe561bde8544e93de50fde213ace5f4b03c57121f039694fdd51a8fb83daf19a71ae95
-  data.tar.gz: 9ce11822c56e0f538a19bc5fcb658a385218b63b736f4fb39d5e0e427c5123502b0a145bf74fa9ccba9664037c6b0a6fbf90acb51edc06400b066b95e20193f8
+  metadata.gz: 2b05b0540f632e54157710557efb70fb27518b5a88e43e61093ea877b98bf60c4cf662c3cd838398694329eef1f30723f662d2fffb10df03d3edd8d1c701328f
+  data.tar.gz: e292d222c897f8a2d24ef1cd42a15123deeedc5a100184bc65d193f7ce5eb6b2ef2f3fa0bbb8f7f9c1791069aa815c8e734695d778d2b1102bc3ecfa011fd76f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nightcrawler_swift (0.1.1)
+    nightcrawler_swift (0.2.0)
       rest-client (>= 1.7.0)
 
 GEM

data/README.md

@@ -1,6 +1,6 @@
 # Nightcrawler Swift
 
-Like the X-Men nightcrawler it teleports your assets to a OpenStack Swift bucket/container
+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.
 
 ## Installation
 
@@ -19,28 +19,25 @@ Or install it yourself as:
 ## Usage
 
 ### With Rails
-#### 1) You will need to configure your swift credentials
+#### 1) Configure your swift credentials
+
+_In config/application.rb_ or _config/environments/*.rb_
 
 ```ruby
-NightcrawlerSwift.configure({
-  bucket: "rogue",
-  tenant_name: "nightcrawler"
-  username: "my_username1",
-  password: "my_password1",
-  auth_url: "https://auth.url.com:123/v2.0/tokens"
-})
+config.nightcrawler_swift.bucket = "rogue"
+config.nightcrawler_swift.tenent_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"
 ```
 
-You could create an initializer with this code.
-
-#### 2) Load rake tasks into your Rakefile
+By default it will use ```Rails.logger``` as logger, to change that use a different logger in configurations, like:
 
 ```ruby
-require 'nightcrawler_swift'
-load 'nightcrawler_swift/tasks/asset_sync.rake'
+config.nightcrawler_swift.logger = Logger.new(STDOU)
 ```
 
-#### 3) Profit!
+#### 2) Profit!
 
 ```sh
 rake nightcrawler_swift:rails:asset_sync
@@ -50,11 +47,25 @@ It will invoke ```rake assets:precompile``` and will copy your public directory
 
 ### Programatically
 
-#### 1) Configure
+#### 1) Configure your swift credentials
+
+```ruby
+NightcrawlerSwift.configure({
+  bucket: "rogue",
+  tenant_name: "nightcrawler"
+  username: "my_username1",
+  password: "my_password1",
+  auth_url: "https://auth.url.com:123/v2.0/tokens"
+})
+```
+
+By default it will use ```Logger.new(STDOUT)``` as logger, to change that use:
 
-Repeat the first step of Rails guide
+```ruby
+NightcrawlerSwift.logger = Logger.new(StringIO.new)
+```
 
-#### 2) Call method sync with the desired directory
+#### 2) Use method sync with the desired directory
 
 ```ruby
 NightcrawlerSwift.sync File.expand_path("./my-dir")
@@ -62,21 +73,21 @@ NightcrawlerSwift.sync File.expand_path("./my-dir")
 
 ## Commands
 
-NightcrawlerSwift packs some useful commands. All commands requires that the gem has already been configured and the connection established.
+NightcrawlerSwift has some useful built-in commands. All commands require the configuration and a established connection.
 
-To Establish the connection, call:
+To Establish the connection, use:
 
 ```ruby
 NightcrawlerSwift.connection.connect!
 ```
 
-To check if the connection is still valid, call:
+To check if the connection is still valid, use:
 
 ```ruby
 NightcrawlerSwift.connection.connected?
 ```
 
-To reconnect just call ```NightcrawlerSwift.connection.connect!``` again.
+To reconnect just use ```NightcrawlerSwift.connection.connect!``` again.
 
 ### Upload
 
@@ -86,6 +97,18 @@ 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_
+
+### Download
+
+```ruby
+download = NightcrawlerSwift::Download.new
+download.execute "my_file_path.txt"
+# File content
+```
+
+_This download command was not designed to retrieve very large files_
+
 ### List
 
 ```ruby

data/lib/nightcrawler_swift.rb

@@ -7,9 +7,11 @@ require "nightcrawler_swift/exceptions"
 require "nightcrawler_swift/command"
 require "nightcrawler_swift/connection"
 require "nightcrawler_swift/upload"
+require "nightcrawler_swift/download"
 require "nightcrawler_swift/list"
 require "nightcrawler_swift/delete"
 require "nightcrawler_swift/sync"
+require "nightcrawler_swift/railtie" if defined?(Rails)
 
 module NightcrawlerSwift
   class << self

data/lib/nightcrawler_swift/connection.rb

@@ -1,6 +1,6 @@
 module NightcrawlerSwift
   class Connection
-    attr_accessor :opts, :auth_response, :token_id, :expires_at, :admin_url, :upload_url
+    attr_accessor :opts, :auth_response, :token_id, :expires_at, :admin_url, :upload_url, :public_url
 
     # Hash with: bucket, tenant_name, username, password, auth_url
     #
@@ -9,36 +9,41 @@ module NightcrawlerSwift
     end
 
     def connect!
-      response = RestClient.post(
-        opts.auth_url,
-        {
-          auth: {
-            tenantName: opts.tenant_name,
-            passwordCredentials: {username: opts.username, password: opts.password}
-          }
-        }.to_json,
-
-        content_type: :json,
-        accept: :json,
-      )
+      auth_response = authenticate!
 
-      @auth_response = OpenStruct.new(JSON.parse(response.body))
-      @token_id = @auth_response.access["token"]["id"]
-      @expires_at = @auth_response.access["token"]["expires"]
+      @token_id = auth_response.access["token"]["id"]
+      @expires_at = auth_response.access["token"]["expires"]
       @expires_at = DateTime.parse(@expires_at).to_time
 
-      @admin_url = @auth_response.access["serviceCatalog"].first["endpoints"].first["adminURL"]
+      @admin_url = auth_response.access["serviceCatalog"].first["endpoints"].first["adminURL"]
       @upload_url = "#{@admin_url}/#{opts.bucket}"
+      @public_url = auth_response.access["serviceCatalog"].first["endpoints"].first["publicURL"]
 
       NightcrawlerSwift.logger.info  "Connected, token_id: #{@token_id}"
       self
-
-    rescue StandardError => e
-      raise Exceptions::ConnectionError.new(e)
     end
 
     def connected?
       !self.token_id.nil? and self.expires_at > Time.now
     end
+
+    private
+
+    def authenticate!
+      auth_options = {
+        tenantName: opts.tenant_name,
+        passwordCredentials: {username: opts.username, password: opts.password}
+      }
+
+      response = RestClient.post(
+        opts.auth_url, { auth: auth_options }.to_json,
+        content_type: :json,
+        accept: :json,
+      )
+
+      OpenStruct.new(JSON.parse(response.body))
+    rescue StandardError => e
+      raise Exceptions::ConnectionError.new(e)
+    end
   end
 end

data/lib/nightcrawler_swift/download.rb

@@ -0,0 +1,16 @@
+module NightcrawlerSwift
+  class Download < Command
+
+    def execute path
+      response = get "#{connection.public_url}/#{path}"
+      response.body
+
+    rescue RestClient::ResourceNotFound => e
+      raise Exceptions::NotFoundError.new(e)
+
+    rescue StandardError => e
+      raise Exceptions::ConnectionError.new(e)
+    end
+
+  end
+end

data/lib/nightcrawler_swift/railtie.rb

@@ -0,0 +1,21 @@
+require "rails"
+require "active_support/ordered_hash"
+
+module NightcrawlerSwift
+  class Railtie < Rails::Railtie
+    railtie_name :nightcrawler_swift
+    config.nightcrawler_swift = ActiveSupport::OrderedOptions.new
+
+    rake_tasks do
+      load "nightcrawler_swift/tasks/asset_sync.rake"
+    end
+
+    initializer "nightcrawler_swift.configure" do |app|
+      settings = app.config.nightcrawler_swift
+      logger = settings.delete(:logger) || Rails.logger
+
+      NightcrawlerSwift.configure settings
+      NightcrawlerSwift.logger = logger
+    end
+  end
+end

data/lib/nightcrawler_swift/tasks/asset_sync.rake

@@ -3,7 +3,7 @@ require "nightcrawler_swift"
 namespace :nightcrawler_swift do
   namespace :rails do
 
-    desc "Synchronizes the assets"
+    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")

data/lib/nightcrawler_swift/version.rb

@@ -1,3 +1,3 @@
 module NightcrawlerSwift
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/nightcrawler_swift.gemspec

@@ -6,9 +6,9 @@ require 'nightcrawler_swift/version'
 Gem::Specification.new do |spec|
   spec.name          = "nightcrawler_swift"
   spec.version       = NightcrawlerSwift::VERSION
-  spec.authors       = ["tulios", "roberto"]
+  spec.authors       = ["tulios", "robertosoares"]
   spec.email         = ["ornelas.tulio@gmail.com", "roberto.tech@gmail.com"]
-  spec.summary       = %q{Like the X-Men nightcrawler it teleports your assets to a OpenStack Swift bucket/container}
+  spec.summary       = %q{Like the X-Men nightcrawler this gem teleports your assets to a OpenStack Swift bucket/container}
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/tulios/nightcrawler_swift"
   spec.license       = "MIT"

data/spec/lib/nightcrawler_swift/connection_spec.rb

@@ -60,16 +60,6 @@ describe NightcrawlerSwift::Connection do
           and_return(auth_success_response)
       end
 
-      it "stores the auth response" do
-        subject.connect!
-        expect(subject.auth_response).to_not be_nil
-
-
-        auth_success_json.keys.each do |key|
-          expect(subject.auth_response.send(key)).to eql(auth_success_json[key])
-        end
-      end
-
       it "stores the token id" do
         subject.connect!
         expect(subject.token_id).to eql(auth_success_json["access"]["token"]["id"])
@@ -91,6 +81,11 @@ describe NightcrawlerSwift::Connection do
         expect(subject.upload_url).to eql("#{subject.admin_url}/#{opts[:bucket]}")
       end
 
+      it "stores the public_url" do
+        subject.connect!
+        expect(subject.public_url).to eql(auth_success_json["access"]["serviceCatalog"].first["endpoints"].first["publicURL"])
+      end
+
       it "returns self" do
         expect(subject.connect!).to eql(subject)
       end

data/spec/lib/nightcrawler_swift/download_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe NightcrawlerSwift::Download do
+
+  subject do
+    NightcrawlerSwift::Download.new
+  end
+
+  describe "#execute" do
+    let :connection do
+      double :connection, public_url: "server-url"
+    end
+
+    let :execute do
+      subject.execute "file_path"
+    end
+
+    before do
+      allow(NightcrawlerSwift).to receive(:connection).and_return(connection)
+      allow(subject).to receive(:get).and_return(response)
+    end
+
+    context "success" do
+      let :response do
+        double(:response, code: 200, body: "content")
+      end
+
+      it "gets using upload url" do
+        execute
+        expect(subject).to have_received(:get).with("server-url/file_path")
+      end
+
+      it "returns body" do
+        expect(execute).to eql "content"
+      end
+    end
+
+    context "when the file does not exist" do
+      let :response do
+        double(:response, code: 404)
+      end
+
+      before do
+        allow(subject).to receive(:get).and_raise(RestClient::ResourceNotFound.new(response))
+      end
+
+      it "raises NightcrawlerSwift::Exceptions::NotFoundError" do
+        expect { execute }.to raise_error NightcrawlerSwift::Exceptions::NotFoundError
+      end
+    end
+
+    context "when another error happens" do
+      let :response do
+        double(:response, code: 500)
+      end
+
+      before do
+        allow(subject).to receive(:get).and_raise(RuntimeError.new(response))
+      end
+
+      it "raises NightcrawlerSwift::Exceptions::ConnectionError" do
+        expect { execute }.to raise_error NightcrawlerSwift::Exceptions::ConnectionError
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: nightcrawler_swift
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - tulios
-- roberto
+- robertosoares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -81,8 +81,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Like the X-Men nightcrawler it teleports your assets to a OpenStack Swift
-  bucket/container
+description: Like the X-Men nightcrawler this gem teleports your assets to a OpenStack
+  Swift bucket/container
 email:
 - ornelas.tulio@gmail.com
 - roberto.tech@gmail.com
@@ -103,8 +103,10 @@ files:
 - lib/nightcrawler_swift/command.rb
 - lib/nightcrawler_swift/connection.rb
 - lib/nightcrawler_swift/delete.rb
+- lib/nightcrawler_swift/download.rb
 - lib/nightcrawler_swift/exceptions.rb
 - lib/nightcrawler_swift/list.rb
+- lib/nightcrawler_swift/railtie.rb
 - lib/nightcrawler_swift/sync.rb
 - lib/nightcrawler_swift/tasks/asset_sync.rake
 - lib/nightcrawler_swift/upload.rb
@@ -117,6 +119,7 @@ files:
 - spec/lib/nightcrawler_swift/command_spec.rb
 - spec/lib/nightcrawler_swift/connection_spec.rb
 - spec/lib/nightcrawler_swift/delete_spec.rb
+- 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/upload_spec.rb
@@ -145,8 +148,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Like the X-Men nightcrawler it teleports your assets to a OpenStack Swift
-  bucket/container
+summary: Like the X-Men nightcrawler this gem teleports your assets to a OpenStack
+  Swift bucket/container
 test_files:
 - spec/fixtures/assets/ex1.txt
 - spec/fixtures/assets/ex2.txt
@@ -155,6 +158,7 @@ test_files:
 - spec/lib/nightcrawler_swift/command_spec.rb
 - spec/lib/nightcrawler_swift/connection_spec.rb
 - spec/lib/nightcrawler_swift/delete_spec.rb
+- 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/upload_spec.rb