nightcrawler_swift 0.11.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a01ca41080d2e2b24b9005e7fa2e4da34c6fef4b
-  data.tar.gz: eae62f063a96a74260358ea140eba27ac03e219c
+  metadata.gz: 7368872bbed33a3a4928360a3162cbec161ad31d
+  data.tar.gz: 7599b6e39f3e7a0c376518beed4deb89978a68f9
 SHA512:
-  metadata.gz: 73107c34d413732b19acb85ad51e5cf1e7bf1268cf3f73206d22d09cf6c66db95a94a3c5148638f2256db7955bf89d7f348c00478a482b92d1c9104d00da6f72
-  data.tar.gz: a056ef9ea2ce5cef78410e93a368dc6aff253152ea40fa1b5987be66b8a33dde52f040e0167f173e231bdd24c5f1d1ef80671be6a010f9d2cc0c3e5cd55dd3a0
+  metadata.gz: c4d15c9c9fc23c71b7dfa04cceaa00bf0152603fae8372c5527a5a0cbfce9bbf54438d4c334d39ad483e94b4d2ff724f90e663273e7ca833aef65341243bcbc0
+  data.tar.gz: 866b75e3f995ce7754712bb12b13967ff5009d2db7a5e657aba7b14bc6865b9b5222b212ba7b21c96331d6b0ed9663b57ba6bcdd7853ac5502470e21c2348bb8

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.2
+ruby-2.4.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nightcrawler_swift (0.11.1)
+    nightcrawler_swift (1.0.0)
       concurrent-ruby (~> 0.8.0)
       multi_mime (>= 1.1.0)
       rest-client
@@ -21,7 +21,7 @@ GEM
     debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    domain_name (0.5.20160826)
+    domain_name (0.5.20170404)
       unf (>= 0.0.5, < 1.0.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
@@ -33,7 +33,7 @@ GEM
     netrc (0.11.0)
     rake (10.3.2)
     ref (1.0.5)
-    rest-client (2.0.0)
+    rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
@@ -58,7 +58,7 @@ GEM
     timecop (0.8.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.2)
+    unf_ext (0.0.7.4)
 
 PLATFORMS
   ruby
@@ -73,4 +73,4 @@ DEPENDENCIES
   timecop
 
 BUNDLED WITH
-   1.13.5
+   1.15.3

data/README.md

@@ -6,6 +6,10 @@
 
 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.
 
+## Compatibility
+
+nightcrawler_swift version 1.x is compatible with [Identity API v3](https://developer.openstack.org/api-ref/identity/v3/index.html). To use [API v2](https://developer.openstack.org/api-ref/identity/v2/index.html), you should install version 0.x.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,16 +18,28 @@ Add this line to your application's Gemfile:
 gem 'nightcrawler_swift'
 ```
 
+Or, if you want to use Identity API v2:
+
+```ruby
+gem 'nightcrawler_swift', '< 1.0'
+```
+
 And then execute:
 
 ```sh
 $ bundle
 ```
 
-Or install it yourself as:
+Or install it manually:
+
+```sh
+$ gem install nightcrawler_swift  # Install latest version
+```
+
+Or set a specific version:
 
 ```sh
-$ gem install nightcrawler_swift
+$ gem install nightcrawler_swift -v 0.11.1
 ```
 
 ## Usage

data/lib/nightcrawler_swift/commands/delete.rb

@@ -7,7 +7,7 @@ module NightcrawlerSwift
       end
 
       response = delete "#{connection.upload_url}/#{path}", headers: { accept: :json }
-      [200, 201].include?(response.code)
+      response.code >= 200 && response.code < 300
     end
 
   end

data/lib/nightcrawler_swift/commands/upload.rb

@@ -2,6 +2,10 @@ module NightcrawlerSwift
   class Upload < Command
 
     def execute path, file, opts = {}
+      if path.nil? or path.empty?
+        raise Exceptions::ValidationError.new "Upload command requires a path parameter"
+      end
+
       body = file.read
       headers = {etag: etag(body), content_type: content_type(file)}
 
@@ -18,7 +22,7 @@ module NightcrawlerSwift
       headers.merge!(custom_headers) if custom_headers
 
       response = put "#{connection.upload_url}/#{path}", body: body, headers: headers
-      [200, 201].include?(response.code)
+      response.code >= 200 && response.code < 300
     end
 
     private

data/lib/nightcrawler_swift/connection.rb

@@ -50,7 +50,7 @@ module NightcrawlerSwift
       headers = {content_type: :json, accept: :json}
       response = Gateway.new(url).request {|r| r.post(auth_options.to_json, headers)}
 
-      @auth_response = OpenStruct.new(JSON.parse(response.body))
+      @auth_response = OpenStruct.new(headers: response.headers, body: JSON.parse(response.body))
     rescue StandardError => e
       raise Exceptions::ConnectionError.new(e)
     end
@@ -58,32 +58,52 @@ module NightcrawlerSwift
     def auth_options
       {
         auth: {
-          tenantName: opts.tenant_name,
-          passwordCredentials: {username: opts.username, password: opts.password}
+          identity: {
+              methods: [
+                  "password"
+              ],
+              password: {
+                  user: {
+                      domain: {
+                          id: "default"
+                      },
+                      name: opts.username,
+                      password: opts.password
+                  }
+              }
+          },
+          scope: {
+              project: {
+                  domain: {
+                      id: "default"
+                  },
+                  name: opts.tenant_name
+              }
+          }
         }
       }
     end
 
     def select_token
-      @token_id = auth_response.access["token"]["id"]
-      @expires_at = auth_response.access["token"]["expires"]
+      @token_id = auth_response.headers[:x_subject_token]
+      @expires_at = auth_response.body["token"]["expires_at"]
       @expires_at = DateTime.parse(@expires_at).to_time
     end
 
     def select_catalog
-      catalogs = auth_response.access["serviceCatalog"]
+      catalogs = auth_response["body"]["token"]["catalog"]
       @catalog = catalogs.find {|catalog| catalog["type"] == "object-store"}
     end
 
     def select_endpoints
       raise Exceptions::ConfigurationError.new "No catalog of type 'object-store' found" if @catalog.nil?
-      @endpoints = @catalog["endpoints"].first
+      @endpoints = @catalog["endpoints"]
     end
 
     def configure_urls
-      @admin_url = opts.admin_url || @endpoints["adminURL"]
-      @public_url = opts.public_url || @endpoints["publicURL"]
-      @internal_url = opts.internal_url || @endpoints["internalURL"]
+      @admin_url = opts.admin_url || @endpoints.find {|e| e["interface"] == "admin"}["url"]
+      @public_url = opts.public_url || @endpoints.find {|e| e["interface"] == "public"}["url"]
+      @internal_url = opts.internal_url || @endpoints.find {|e| e["interface"] == "internal"}["url"]
       @upload_url = "#{@admin_url}/#{opts.bucket}"
     end
   end

data/lib/nightcrawler_swift/version.rb

@@ -1,3 +1,3 @@
 module NightcrawlerSwift
-  VERSION = "0.11.1"
+  VERSION = "1.0.0"
 end

data/spec/fixtures/auth_success.json

@@ -1,62 +1,87 @@
 {
-   "access" : {
-      "serviceCatalog" : [
-         {
-            "name" : "swift",
-            "endpoints_links" : [],
-            "type" : "object-store",
-            "endpoints" : [
-               {
-                  "publicURL" : "http://public-url-com",
-                  "internalURL" : "http://internal-url-com",
-                  "adminURL" : "http://api-url-com",
-                  "region" : "RegionOne",
-                  "id" : "1"
-               }
-            ]
-         },
-         {
-            "name" : "keystone",
-            "endpoints_links" : [],
-            "type" : "identity",
-            "endpoints" : [
-               {
-                  "publicURL" : "http://auth-url-com:123/v2.0",
-                  "internalURL" : "https://auth-url-com:123/v2.0",
-                  "adminURL" : "https://auth-url-com:321/v2.0",
-                  "region" : "RegionOne",
-                  "id" : "2"
-               }
-            ]
-         }
+  "headers": {
+    "X-Subject-Token": "12345"
+  },
+  "body": {
+    "token": {
+      "methods": [
+        "password"
       ],
-      "user" : {
-         "roles" : [
+      "roles": [
+        {
+          "id": "3fe2ff9ee4384b1894a90878d3e92bab",
+          "name": "_member_"
+        },
+        {
+          "id": "c573d00d11ed4f75a7cae8e7527eb1ed",
+          "name": "swiftoperator"
+        }
+      ],
+      "expires_at": "2017-07-06T18:24:31.037559Z",
+      "project": {
+        "domain": {
+          "id": "default",
+          "name": "Default"
+        },
+        "id": "5c6a4110f7f9436b8e1f6696f9f6a13f",
+        "name": "tenant_username1"
+      },
+      "catalog": [
+        {
+          "name" : "swift",
+          "id": "0f7d75e8a91249628ad63356002b4869",
+          "type" : "object-store",
+          "endpoints" : [
+            {
+              "region_id": "RegionOne",
+              "url": "http://auth-url-com:123/v3/admin",
+              "region": "RegionOne",
+              "interface": "admin",
+              "id": "a723954cc89d3e93a65c1f658132773d"
+            },
             {
-               "name" : "swiftoperator"
+              "region_id": "RegionOne",
+              "url": "http://auth-url-com:123/v3/internal",
+              "region": "RegionOne",
+              "interface": "internal",
+              "id": "beea797b69fa47159e44a220ea05c61c"
+            },
+            {
+              "region_id": "RegionOne",
+              "url": "http://auth-url-com:123/v3/public",
+              "region": "RegionOne",
+              "interface": "public",
+              "id": "9e36056aba514263a1d1d8ae10cfb796"
             }
-         ],
-         "roles_links" : [],
-         "name" : "User Name 1",
-         "id" : "3",
-         "username" : "username1"
-      },
-      "metadata" : {
-         "roles" : [
-            "4"
-         ],
-         "is_admin" : 0
+          ]
+        },
+        {
+          "name" : "keystone",
+          "id" : "7efb509d3a0b446fa324d0bc4503e6d3",
+          "type" : "identity",
+          "endpoints" : [
+            {
+              "region_id" : "RegionOne",
+              "url" : "http://auth-url-com:123/v3/public",
+              "interface": "public",
+              "id" : "29e36056aba514263a1d1d8ae10cfb79"
+            }
+          ]
+        }
+      ],
+      "extras": {},
+      "user": {
+        "domain": {
+          "id": "default",
+          "name": "Default"
+        },
+        "id": "83e2c39492e343f08b0621ddc2e46eab",
+        "name": "username1"
       },
-      "token" : {
-         "tenant" : {
-            "name" : "tenant_username1",
-            "id" : "5",
-            "description" : "some desc",
-            "enabled" : true
-         },
-         "issued_at" : "2014-08-25T17:53:26.667691",
-         "id" : "5",
-         "expires" : "2014-08-25T18:53:26Z"
-      }
-   }
+      "audit_ids": [
+        "B77HzuC7QimfKre8DhDrhw"
+      ],
+      "issued_at": "2017-07-06T17:24:31.037629Z"
+    }
+  }
 }

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

@@ -25,7 +25,7 @@ describe NightcrawlerSwift::Delete do
 
     context "success" do
       let :response do
-        double(:response, code: 200)
+        double(:response, code: 204)
       end
 
       before do
@@ -42,6 +42,20 @@ describe NightcrawlerSwift::Delete do
       end
     end
 
+    context "failure" do
+      let :response do
+        double(:response, code: 404)
+      end
+
+      before do
+        allow(subject).to receive(:delete).and_return(response)
+      end
+
+      it "returns false" do
+        expect(execute).to eql false
+      end
+    end
+
     context "when the path was not informed" do
       it "raises NightcrawlerSwift::Exceptions::ValidationError" do
         expect { subject.execute nil }.to raise_error NightcrawlerSwift::Exceptions::ValidationError

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

@@ -165,6 +165,13 @@ describe NightcrawlerSwift::Upload do
       let(:response) { double(:response, code: 500) }
       it { expect(execute).to be false }
     end
+
+    context "when the path was not informed" do
+      it "raises NightcrawlerSwift::Exceptions::ValidationError" do
+        expect { subject.execute(nil, file) }.to raise_error NightcrawlerSwift::Exceptions::ValidationError
+        expect { subject.execute("", file) }.to raise_error NightcrawlerSwift::Exceptions::ValidationError
+      end
+    end
   end
 
 end

data/spec/lib/nightcrawler_swift/connection_spec.rb

@@ -8,7 +8,7 @@ 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/v3/auth/tokens",
       max_age: 31536000 # 1 year
     }
   end
@@ -30,19 +30,48 @@ describe NightcrawlerSwift::Connection do
     let :auth_json do
       {
         auth: {
-          tenantName: opts[:tenant_name],
-          passwordCredentials: {username: opts[:username], password: opts[:password]}
+          identity: {
+            methods: [
+                "password"
+            ],
+            password: {
+              user: {
+               domain: {
+                 id: "default"
+               },
+               name: opts[:username],
+               password: opts[:password]
+              }
+            }
+          },
+          scope: {
+            project: {
+              domain: {
+                id: "default"
+              },
+              name: opts[:tenant_name]
+            }
+          }
         }
       }.to_json
     end
 
     let :auth_success_response do
       path = File.join(File.dirname(__FILE__), "../..", "fixtures/auth_success.json")
-      OpenStruct.new(body: File.read(File.expand_path(path)))
+      file_contents = JSON.parse(File.read(File.expand_path(path)))
+      headers = file_contents["headers"].reduce({}) do |h, item|
+        key, value = item
+        h[key.downcase.gsub("-", "_").to_sym] = value
+        h
+      end
+      OpenStruct.new(headers: headers, body: file_contents["body"].to_json)
     end
 
     let :auth_success_json do
-      JSON.parse(auth_success_response.body)
+      {
+        "headers" => auth_success_response.headers,
+        "body" => JSON.parse(auth_success_response.body)
+      }
     end
 
     describe "when it connects" do
@@ -61,48 +90,55 @@ describe NightcrawlerSwift::Connection do
           and_return(auth_success_response)
       end
 
-      it "stores the auth_response" do
+      it "stores the auth response body" do
         subject.connect!
         # 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))
+        expect(subject.auth_response.body).to eq(auth_success_json["body"])
+      end
+
+      it "stores the auth response headers" do
+        subject.connect!
+        expect(subject.auth_response.headers).to eq(auth_success_json["headers"])
       end
 
       it "stores the token id" do
         subject.connect!
-        expect(subject.token_id).to eql(auth_success_json["access"]["token"]["id"])
+        expect(subject.token_id).not_to be_nil
+        expect(subject.token_id).to eql(auth_success_json["headers"][:x_subject_token])
       end
 
       it "stores the expires_at" do
         subject.connect!
-        expires_at = DateTime.parse(auth_success_json["access"]["token"]["expires"]).to_time
+        expires_at = DateTime.parse(auth_success_json["body"]["token"]["expires_at"]).to_time
         expect(subject.expires_at).to eql(expires_at)
       end
 
       it "stores the catalog" do
-        expect(subject).to receive(:connect!).and_call_original
-        expect(subject.catalog).to eql(auth_success_json["access"]["serviceCatalog"][0])
+        subject.connect!
+        expect(subject.catalog).to eql(auth_success_json["body"]["token"]["catalog"][0])
+        expect(subject.catalog["type"]).to eql("object-store")
       end
 
       it "stores the admin_url" do
-        expect(subject).to receive(:connect!).and_call_original
-        expect(subject.admin_url).to eql(auth_success_json["access"]["serviceCatalog"].first["endpoints"].first["adminURL"])
+        subject.connect!
+        expect(subject.admin_url).to eql(auth_success_json["body"]["token"]["catalog"][0]["endpoints"][0]["url"])
       end
 
       it "stores the upload_url" do
+        subject.connect!
         admin_url = subject.admin_url
-        expect(subject).to receive(:connect!).and_call_original
         expect(subject.upload_url).to eql("#{admin_url}/#{opts[:bucket]}")
       end
 
       it "stores the public_url" do
-        expect(subject).to receive(:connect!).and_call_original
-        expect(subject.public_url).to eql(auth_success_json["access"]["serviceCatalog"].first["endpoints"].first["publicURL"])
+        subject.connect!
+        expect(subject.public_url).to eql(auth_success_json["body"]["token"]["catalog"][0]["endpoints"][2]["url"])
       end
 
       it "stores the internal_url" do
-        expect(subject).to receive(:connect!).and_call_original
-        expect(subject.internal_url).to eql(auth_success_json["access"]["serviceCatalog"].first["endpoints"].first["internalURL"])
+        subject.connect!
+        expect(subject.internal_url).to eql(auth_success_json["body"]["token"]["catalog"][0]["endpoints"][1]["url"])
       end
 
       it "returns self" do
@@ -111,7 +147,7 @@ describe NightcrawlerSwift::Connection do
 
       context "and there isn't any catalog configured" do
         before do
-          auth_success_json["access"]["serviceCatalog"] = []
+          auth_success_json["body"]["token"]["catalog"] = []
           allow(subject).to receive(:auth_response).and_return(OpenStruct.new(auth_success_json))
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nightcrawler_swift
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 1.0.0
 platform: ruby
 authors:
 - tulios
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Like the X-Men nightcrawler this gem teleports your assets to a OpenStack