footrest 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d9f5d760ae83f164678724a9ecfd76f4df5336e
-  data.tar.gz: ed689789278afacb33efde02088ee327a10eb67f
+  metadata.gz: c8c6985d2101e71eaaf3391e815b44956a245c6b
+  data.tar.gz: 2fafab4c249ddfcb5681c172e21e3deb88e79368
 SHA512:
-  metadata.gz: 45bec9c171db1ada2ae5705b75a17cf1631aaba8b06649213d1b385fbcbf30e46f4975fd0ff4721f86beea111e5e887dc8e357c6ec50162e6d6f6db2102953b9
-  data.tar.gz: cd1533a1211613833447f82887c859cfcff40aeb9c3fcaf61456258ecc3027734d7793c2ef317ce5388c89634f1c0108dde98ad559af8ec17565e50813413356
+  metadata.gz: aaeb3a45a5c52a676ae12112abfd3a1ee10455c33f8b2a09687f4df6ac16228d1aa0b7f43a75be399286fb13400a567561cce2a90e29fc99a91d66aec2bc8b91
+  data.tar.gz: 0ff91ef3cbbaaf112e4a327baf08de84af3188e9bbf60fc0d40553750d4f295b130570e28813d9e1f74eefa9c04606f28f5694f2dc808751fcf846a6a6894517

data/footrest.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "bundler", ">= 1.0.0"
-  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "rspec", "~> 3.3"
   gem.add_development_dependency "webmock"
   gem.add_development_dependency "pry"
+  gem.add_development_dependency "byebug"
 
   gem.add_dependency "faraday", "~> 0.9.0"
   gem.add_dependency "activesupport", ">= 3.0.0"

data/lib/footrest/http_error.rb

@@ -13,24 +13,20 @@ module Footrest
         @body = @response[:body]
         @method = @response[:method]
 
-        super("HTTP ERROR: #{@status} #{method} #{url}\n#{errors}\n#{headers}")
+        super("HTTP ERROR: #{status} (#{status_message}) #{method} #{url}\n#{errors}\n#{headers}")
       end
 
       def method
         @method.to_s.upcase
-      rescue => e
-        "[Unable to show HTTP method: #{e}]"
       end
 
       def url
         @response.url.to_s
-      rescue => e
-        "[Unable to show URL: #{e}]"
       end
 
       def headers
         JSON::pretty_generate(
-          request: @response.request_headers,
+          request: sanitized_request_headers,
           response: @response.response_headers
         )
       rescue => e
@@ -42,6 +38,26 @@ module Footrest
       rescue
         @body
       end
+
+      def status_message
+        HTTP_STATUS_CODES.fetch(status, 'UNKNOWN STATUS')
+      end
+
+      def sanitized_request_headers
+        return request_headers unless request_headers['Authorization']
+        request_headers.merge('Authorization' => truncated_authorization_value)
+      end
+
+      def request_headers
+        @response.request_headers
+      end
+
+      def truncated_authorization_value
+        bearer, token = request_headers['Authorization'].split(/\s+/)
+        token_parts = token.split('~')
+        token_parts[-1] = token_parts.last[0, 4]
+        "Bearer #{token_parts.join('~')}..."
+      end
     end
 
     %w(
@@ -72,4 +88,66 @@ module Footrest
     end
   end
 
-end
+  # Every standard HTTP code mapped to the appropriate message. Ripped directly from
+  # the Rack::Utils source :-)
+  HTTP_STATUS_CODES = {
+    100 => 'Continue',
+    101 => 'Switching Protocols',
+    102 => 'Processing',
+    200 => 'OK',
+    201 => 'Created',
+    202 => 'Accepted',
+    203 => 'Non-Authoritative Information',
+    204 => 'No Content',
+    205 => 'Reset Content',
+    206 => 'Partial Content',
+    207 => 'Multi-Status',
+    208 => 'Already Reported',
+    226 => 'IM Used',
+    300 => 'Multiple Choices',
+    301 => 'Moved Permanently',
+    302 => 'Found',
+    303 => 'See Other',
+    304 => 'Not Modified',
+    305 => 'Use Proxy',
+    307 => 'Temporary Redirect',
+    308 => 'Permanent Redirect',
+    400 => 'Bad Request',
+    401 => 'Unauthorized',
+    402 => 'Payment Required',
+    403 => 'Forbidden',
+    404 => 'Not Found',
+    405 => 'Method Not Allowed',
+    406 => 'Not Acceptable',
+    407 => 'Proxy Authentication Required',
+    408 => 'Request Timeout',
+    409 => 'Conflict',
+    410 => 'Gone',
+    411 => 'Length Required',
+    412 => 'Precondition Failed',
+    413 => 'Payload Too Large',
+    414 => 'URI Too Long',
+    415 => 'Unsupported Media Type',
+    416 => 'Range Not Satisfiable',
+    417 => 'Expectation Failed',
+    421 => 'Misdirected Request',
+    422 => 'Unprocessable Entity',
+    423 => 'Locked',
+    424 => 'Failed Dependency',
+    426 => 'Upgrade Required',
+    428 => 'Precondition Required',
+    429 => 'Too Many Requests',
+    431 => 'Request Header Fields Too Large',
+    500 => 'Internal Server Error',
+    501 => 'Not Implemented',
+    502 => 'Bad Gateway',
+    503 => 'Service Unavailable',
+    504 => 'Gateway Timeout',
+    505 => 'HTTP Version Not Supported',
+    506 => 'Variant Also Negotiates',
+    507 => 'Insufficient Storage',
+    508 => 'Loop Detected',
+    510 => 'Not Extended',
+    511 => 'Network Authentication Required'
+  }
+end

data/lib/footrest/version.rb

@@ -1,3 +1,3 @@
 module Footrest
-  VERSION = '0.5.0' unless defined?(Footrest::VERSION)
+  VERSION = '0.5.1' unless defined?(Footrest::VERSION)
 end

data/spec/footrest/http_error_spec.rb

@@ -1,99 +1,162 @@
 require_relative '../spec_helper'
 
-describe Footrest::HttpError do
-  before do
-    @client = Footrest::Client.new(prefix: "http://domain.com", token: "test_token")
-  end
+module Footrest
+  describe HttpError do
+    before do
+      @client = Client.new(prefix: "http://domain.com", token: "test_token")
+    end
+
+    describe HttpError::ErrorBase, :focus do
+      let(:response) { Faraday::Env.new(
+        :get,
+        {errors: [{message: "I don't even"}]}.to_json,
+        URI.parse('http://domain.com/api/v1/not_found'),
+        Faraday::RequestOptions.new,
+        {
+          "Accept"=>"application/json",
+          "Authorization"=>"Bearer 365~deadbeef123458792",
+          "User-Agent"=>"Footrest"
+        },
+        Faraday::SSLOptions.new,
+        nil,
+        nil,
+        nil,
+        {"Foo-Bar" => 'baz'},
+        400
+      ) }
+      let(:error) { HttpError::ErrorBase.new(response) }
+
+      describe '#initialize(response)' do
+        it 'must include the status code in the message' do
+          expect(error.message).to include '400'
+        end
+
+        it 'must include the status message for the status code in the message' do
+          expect(error.message).to include 'Bad Request'
+        end
+
+        it 'must include the http method in the request method in the message' do
+          expect(error.message).to include 'GET'
+        end
+
+        it 'must include the request url in the message' do
+          expect(error.message).to include 'http://domain.com/api/v1/not_found'
+        end
+
+        it 'must include the parsed errors in the message' do
+          expect(error.message).to include "I don't even"
+        end
+
+        it 'must include the response headers in the message' do
+          expect(error.message).to include 'Foo-Bar'
+        end
+
+        it 'must include the sanitized request headers in the message' do
+          expect(error.message).to include 'Bearer 365~dead...'
+        end
+      end
+
+      describe '#sanitized_request_headers' do
+        it 'must truncate the value for the Authorization header when it looks like a production Canvas token' do
+          expect(error.sanitized_request_headers).to include 'Authorization' => 'Bearer 365~dead...'
+        end
+
+        it 'must truncate the value for the Authorization header when it looks like a generic Bearer token' do
+          response.request_headers['Authorization'] = 'Bearer this-token-is-super-sekret'
+          expect(error.sanitized_request_headers).to include 'Authorization' => 'Bearer this...'
+        end
+      end
+    end
 
-  it "raises a bad request error" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 400)
+    it "raises a bad request error" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 400)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::BadRequest => e
-      expect(e.status).to eq(400)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::BadRequest => e
+        expect(e.status).to eq(400)
+      end
     end
-  end
 
-  it "raises a unauthorized error" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 401)
+    it "raises a unauthorized error" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 401)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::Unauthorized => e
-      expect(e.status).to eq(401)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::Unauthorized => e
+        expect(e.status).to eq(401)
+      end
     end
-  end
 
-  it "raises a forbidden error" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 403)
+    it "raises a forbidden error" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 403)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::Forbidden => e
-      expect(e.status).to eq(403)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::Forbidden => e
+        expect(e.status).to eq(403)
+      end
     end
-  end
 
 
-  it "raises a not found error" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 404)
+    it "raises a not found error" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 404)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::NotFound => e
-      expect(e.status).to eq(404)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::NotFound => e
+        expect(e.status).to eq(404)
+      end
     end
-  end
 
-  it "raises a method not found allowed" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 405)
+    it "raises a method not found allowed" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 405)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::MethodNotAllowed => e
-      expect(e.status).to eq(405)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::MethodNotAllowed => e
+        expect(e.status).to eq(405)
+      end
     end
-  end
 
-  it "raises a internal server error" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 500)
+    it "raises a internal server error" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 500)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::InternalServerError => e
-      expect(e.status).to eq(500)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::InternalServerError => e
+        expect(e.status).to eq(500)
+      end
     end
-  end
 
-  it "raises a not implemented error" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 501)
+    it "raises a not implemented error" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 501)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::NotImplemented => e
-      expect(e.status).to eq(501)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::NotImplemented => e
+        expect(e.status).to eq(501)
+      end
     end
-  end
 
-  it "raises a bad gateway error" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 502)
+    it "raises a bad gateway error" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 502)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::BadGateway => e
-      expect(e.status).to eq(502)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::BadGateway => e
+        expect(e.status).to eq(502)
+      end
     end
-  end
 
-  it "raises a Server Unavailible error" do
-    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 503)
+    it "raises a Server Unavailible error" do
+      stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 503)
 
-    begin
-      @client.get "/api/v1/not_found"
-    rescue Footrest::HttpError::ServiceUnavailable => e
-      expect(e.status).to eq(503)
+      begin
+        @client.get "/api/v1/not_found"
+      rescue Footrest::HttpError::ServiceUnavailable => e
+        expect(e.status).to eq(503)
+      end
     end
   end
-
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: footrest
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Duane Johnson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: REST APIs
@@ -178,3 +192,4 @@ test_files:
 - spec/footrest/pagination_spec.rb
 - spec/footrest/request_spec.rb
 - spec/spec_helper.rb
+has_rdoc: