apireaper 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a52bdd4fbf202bceeb870138ad230d5e8233f8a
-  data.tar.gz: f236587dcbf0655e2e9477af21090aca0aa898a8
+  metadata.gz: 2b42796a8d05da4a07d24ad0618cc8e35d4e7761
+  data.tar.gz: 939d3457d1a1ab1b21baf562adda3f78115ba047
 SHA512:
-  metadata.gz: 66c2db95b9bd16449b86ef56af70cc9d711dd7df561efaaf0f8d86e848ad325d00c415d2309b4bba92acb531add97725d63885fd9e171e08b1b980a9079f955c
-  data.tar.gz: 9c6e7797822e3eb3890941dee57f0c63dd9a7d824eab0414e23d22de05416ab4705c240a68a72733f767e81fd59aa991cbed2bf57ff5c48bb62735baa00969cd
+  metadata.gz: dcd488923977db3fb1009349ac09661ac34307defe6c93aef2337c776c904da5f2cdf8eb24b599fcca0ba4a5831f3d177923b3dabc54ccb7fb6670a5bcbe31ff
+  data.tar.gz: b9b32361f123d54b3b7cd63c4c30d4a34b68bef4f88103123bd39a0fa2ce82fc000448cbd9e481da8d20a73a04625bade0de03bea8c2d5f599c8a95f3d2d3c09

data/lib/apireaper/checker.rb

@@ -25,16 +25,13 @@ module APIReaper
   class Checker
     # Class constructor method
     def initialize(method, url, opts)
-      @method = method
-      @uri = URI.parse(url)
+      @requester = APIReaper::Requester.new(method, url, opts)
       @opts = opts
-      @http = Net::HTTP.new(@uri.host, @uri.port)
-      @http.use_ssl = @uri.scheme.eql?('https')
     end
 
     # Main method to run the check
     def check
-      res = select_request
+      res = @requester.request
       check_response_code(res.code)
       check_data_structure(res.body)
       puts 'All checks passed' unless @opts['quiet']
@@ -73,60 +70,5 @@ module APIReaper
         @opts['schema_file']
       end
     end
-
-    # Split the data string into a hash
-    def format_data
-      data = {}
-      unless @opts['data'].nil?
-        pairs = @opts['data'].split('&')
-        pairs.each do |pair|
-          (key, value) = pair.split('=')
-          data[key] = value
-        end
-      end
-      data
-    end
-
-    # DELETE method
-    def rest_request_delete
-      exit_with_error(5, 'DELETE is not yet implemented')
-      # TODO
-    end
-
-    # GET method
-    def rest_request_get
-      exit_with_error(5, 'GET is not yet implemented')
-      # TODO
-    end
-
-    # POST method
-    def rest_request_post
-      req = Net::HTTP::Post.new(@uri.request_uri)
-      unless @opts['header'].nil?
-        @opts['header'].split(',').each do |h|
-          (key, value) = h.split(':')
-          req[key] = value
-        end
-      end
-      req.set_form_data(format_data)
-      @http.request(req)
-    end
-
-    # PUT method
-    def rest_request_put
-      exit_with_error(5, 'PUT is not yet implemented')
-      # TODO
-    end
-
-    # Select request method
-    def select_request
-      case @method.upcase
-      when 'DELETE' then rest_request_delete
-      when 'GET' then rest_request_get
-      when 'POST' then rest_request_post
-      when 'PUT' then rest_request_put
-      else raise "#{@method.upcase} is an unknown method"
-      end
-    end
   end
 end

data/lib/apireaper/requester.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/ruby
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module APIReaper
+  # This is a Net HTTP requester class.
+  class Requester
+    # Class constructor method
+    def initialize(method, url, opts)
+      @method = method
+      @uri = URI.parse(url)
+      @opts = opts
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = @uri.scheme.eql?('https')
+    end
+
+    # Exit with the specified errno and message
+    def exit_with_error(errno, message)
+      puts message unless @opts['quiet']
+      exit errno
+    end
+
+    # Select the right data type
+    def format_data(request)
+      return request if @opts['data'].nil?
+      if json?(@opts['data']) then format_json_data(request)
+      elsif www_form?(@opts['data']) then format_www_form_data(request)
+      else raise 'Data type is unknown.'
+      end
+    end
+
+    # Set the headers given as argument
+    def format_header(request)
+      unless @opts['header'].nil?
+        @opts['header'].split(',').each do |h|
+          (key, value) = h.split(':')
+          request[key] = value
+        end
+      end
+      request
+    end
+
+    # Set json data as request body
+    def format_json_data(request)
+      request.body = @opts['data']
+      request
+    end
+
+    # Split the data string into a hash
+    def format_www_form_data(request)
+      data = {}
+      pairs = @opts['data'].split('&')
+      pairs.each do |pair|
+        (key, value) = pair.split('=')
+        data[key] = value
+      end
+      request.set_form_data(data)
+      request
+    end
+
+    # Check if the data string is a well formated json
+    def json?(str)
+      JSON.parse(str)
+      true
+    rescue JSON::ParserError
+      false
+    end
+
+    # Check if the data string is a www form like string
+    def www_form?(str)
+      str.match(/^\w+=\w+(&\w+=\w+)*$/).nil? ? false : true
+    end
+
+    # DELETE method
+    def rest_request_delete
+      exit_with_error(5, 'DELETE is not yet implemented')
+      # TODO
+    end
+
+    # GET method
+    def rest_request_get
+      exit_with_error(5, 'GET is not yet implemented')
+      # TODO
+    end
+
+    # POST method
+    def rest_request_post
+      req = Net::HTTP::Post.new(@uri.request_uri)
+      req = format_data(req)
+      req = format_header(req)
+      @http.request(req)
+    end
+
+    # PUT method
+    def rest_request_put
+      exit_with_error(5, 'PUT is not yet implemented')
+      # TODO
+    end
+
+    # Select request method
+    def request
+      case @method.upcase
+      when 'DELETE' then rest_request_delete
+      when 'GET' then rest_request_get
+      when 'POST' then rest_request_post
+      when 'PUT' then rest_request_put
+      else raise "#{@method.upcase} is an unknown method"
+      end
+    end
+  end
+end

data/lib/apireaper/version.rb

@@ -16,5 +16,5 @@
 #
 
 module APIReaper
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
 end

data/spec/apireaper/checker_spec.rb

@@ -26,77 +26,45 @@ def print_out(code)
 end
 
 describe APIReaper::Checker do # rubocop:disable Metrics/BlockLength
-  %w[delete get put].each do |method|
-    context "check #{method} http://api.test.yueyehua.net/ -q" do
-      it 'tries unimplemented commands.' do
-        expect { start(self) }.to raise_error(SystemExit)
-      end
-    end
-  end
-
-  context 'check notexistingcmd http://api.test.yueyehua.net/ -q' do
-    it 'tries unimplemented commands.' do
-      expect { start(self) }.to raise_error(SystemExit)
-    end
-  end
-
-  context 'check post http://api.test.yueyehua.net/' do
-    it 'requests an API without extra arguments.' do
-      expect { start(self) }.to output(print_out(200)).to_stdout
-    end
-  end
-
-  context 'check post http://api.test.yueyehua.net/ -d k=v' do
-    it 'requests an API with datas.' do
-      expect { start(self) }.to output(print_out(201)).to_stdout
-    end
-  end
-
-  context 'check post http://api.test.yueyehua.net/ -h k:v' do
-    it 'requests an API with headers.' do
-      expect { start(self) }.to output(print_out(202)).to_stdout
-    end
-  end
-
-  context 'check post http://api.test.yueyehua.net/ -q' do
-    it 'requests an API with quiet option.' do
-      expect { start(self) }.to output('').to_stdout
+  context 'check post http://api.test.yueyehua.net/ -h k:v -d k=v' do
+    it 'requests an API and test the response body without defined schema.' do
+      expect { start(self) }.to output(print_out(203)).to_stdout
     end
   end
 
-  context 'check post http://api.fail.yueyehua.net/ -h l:w -d l=w -q' do
-    it 'requests an API and receive 404 status code.' do
-      expect { start(self) }.to raise_error(SystemExit)
+  schema_file = 'spec/files/schema'
+  opts203r1 = "-h k:v -d k=v -F #{schema_file}"
+  context "check post http://api.test.yueyehua.net/ #{opts203r1}" do
+    it 'requests an API and test the response body with schema file.' do
+      expect { start(self) }.to output(print_out(203)).to_stdout
     end
   end
 
-  context 'check post http://api.test.yueyehua.net/ -h k:v -d k=v' do
-    it 'requests an API and test the response body without defined schema.' do
+  schema = File.read(schema_file)
+  opts203r2 = "-h k:v -d k=v -S #{schema}"
+  context "check post http://api.test.yueyehua.net/ #{opts203r2}" do
+    it 'requests an API and test the response body with a schema as option.' do
       expect { start(self) }.to output(print_out(203)).to_stdout
     end
   end
 
   schema_file = 'spec/files/schema'
-  opts1 = "-h k:v -d k=v -F #{schema_file}"
-  context "check post http://api.test.yueyehua.net/ #{opts1}" do
-    it 'requests an API and test the response body with schema file.' do
-      expect { start(self) }.to output(print_out(203)).to_stdout
+  opts204 = "-h k:v -d k=v -q -F #{schema_file}"
+  context "check post http://api.fail.yueyehua.net/ #{opts204}" do
+    it 'requests an API and test the response body with wrong schema file.' do
+      expect { start(self) }.to raise_error(SystemExit)
     end
   end
 
-  schema_file = 'spec/files/schema'
-  opts2 = "-h k:v -d k=v -q -F #{schema_file}"
-  context "check post http://api.fail.yueyehua.net/ #{opts2}" do
-    it 'requests an API and test the response body with schema file.' do
+  context 'check post http://api.fail.yueyehua.net/ -h l:w -d l=w -q' do
+    it 'requests an API and receive 404 status code.' do
       expect { start(self) }.to raise_error(SystemExit)
     end
   end
 
-  schema = JSON.parse(File.read('spec/files/schema'))
-  opts3 = "-h k:v -d k=v -S #{JSON.dump(schema)}"
-  context "check post http://api.test.yueyehua.net/ #{opts3}" do
-    it 'requests an API and test the response body with a schema as option.' do
-      expect { start(self) }.to output(print_out(203)).to_stdout
+  context 'check post http://api.test.yueyehua.net/ -q' do
+    it 'requests an API with quiet option.' do
+      expect { start(self) }.to output('').to_stdout
     end
   end
 end

data/spec/apireaper/stubs/servers_stubs.rb

@@ -23,20 +23,30 @@ end
 
 RSpec.configure do |config|
   config.before(:each) do
+    # requests an API without extra arguments
     stub_request(:post, 'http://api.test.yueyehua.net/')
       .to_return('status' => 200, 'body' => '{}', 'headers' => {})
+    # requests an API with headers
     stub_request(:post, 'http://api.test.yueyehua.net/')
-      .with('body' => { 'k' => 'v' })
+      .with('headers' => { 'k' => 'v' })
       .to_return('status' => 201, 'body' => '{}', 'headers' => {})
+    # requests an API with www_form type datas
     stub_request(:post, 'http://api.test.yueyehua.net/')
-      .with('headers' => { 'k' => 'v' })
+      .with('body' => { '3wfk' => '3wfv' })
       .to_return('status' => 202, 'body' => '{}', 'headers' => {})
+    # requests an API with json type datas
+    stub_request(:post, 'http://api.test.yueyehua.net/')
+      .with('body' => { 'jsonk' => 'jsonv' })
+      .to_return('status' => 203, 'body' => '{}', 'headers' => {})
+    # requests an API and test the response body
     stub_request(:post, 'http://api.test.yueyehua.net/')
       .with('body' => { 'k' => 'v' }, 'headers' => { 'k' => 'v' })
       .to_return('status' => 203, 'body' => body_file('body'), 'headers' => {})
+    # requests an API and test the response body with wrong schema file
     stub_request(:post, 'http://api.fail.yueyehua.net/')
       .with('body' => { 'k' => 'v' }, 'headers' => { 'k' => 'v' })
       .to_return('status' => 204, 'body' => body_file('fail'), 'headers' => {})
+    # requests an API and receive 404 status code
     stub_request(:post, 'http://api.fail.yueyehua.net/')
       .with('body' => { 'l' => 'w' }, 'headers' => { 'l' => 'w' })
       .to_return('status' => 404, 'body' => '{}', 'headers' => {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apireaper
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Richard Delaplace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-13 00:00:00.000000000 Z
+date: 2017-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,7 @@ files:
 - lib/apireaper.rb
 - lib/apireaper/checker.rb
 - lib/apireaper/cli.rb
+- lib/apireaper/requester.rb
 - lib/apireaper/version.rb
 - spec/apireaper/checker_spec.rb
 - spec/apireaper/cli_spec.rb