api_tools 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d1f1a6697b965e58c477d6a010ec1cfd6447575
-  data.tar.gz: 461feec02dba1372e9bd13d0ee5ba0130f60893d
+SHA256:
+  metadata.gz: d6e2677fb5e7c1d3b55653927953900e3de618f7bfa764b4bfd187a2c8c5723f
+  data.tar.gz: e66bd28d4572c7f87aa4c0ac70d8b85b1c0240ffa252b2c531af7aa9963734fe
 SHA512:
-  metadata.gz: f12330f40ec97f66f6d9016b309066b1a0da4f064e51a58572aaced55d5a08b09438bdfabca3cd2a7bbe55b6477c78ff1b440e7932cf503b8a9b9875cf6381e7
-  data.tar.gz: 424a5ae18fb1e0c5ad34358b32027c3f70688f58e78bcefd8c27947bd59b3fbc9684ee77337d151ebd29be0962ea1079aff6f89df57e09cd5fab13fc0b000ccb
+  metadata.gz: 2f381ebbd1f8a1b8463c6a1fd57289288c730fcd9178cf953333ecb223dc2084a4de868baef4c1c36538d3e331c0673cfcd9cd1321b82fde0307dad9e1b7b1c9
+  data.tar.gz: 6888cb1bf2ff0b570c3df8d87707db5b4178e6b2805cce475215c8ded577992e9f84c53611d167915455f408732217eef9ecd5ddf48d787894f69d571e7696d2

data/.gitignore

@@ -14,3 +14,4 @@ pkg
 
 # rspec failure tracking
 .rspec_status
+TAGS

data/Gemfile

@@ -1,7 +1,7 @@
 if ENV["USING_OFFICIAL_GEM"]
   source "https://rubygems.org"
 else
-  source "https://gems.ruby-china.org"
+  source "https://gems.ruby-china.com"
 end
 
 # Specify your gem's dependencies in api_tools.gemspec

data/README.md

@@ -7,4 +7,42 @@
 
 
 ## 使用
-gem 'api_tools', :git => 'git@github.com:jicheng1014/api_tools.git'
+
+### add to Gemfile
+gem 'api_tools', :git => 'https://github.com/jicheng1014/api_tools.git'
+
+## 任意对象
+
+直接使用  DefaultRest.post(url, xxx)    
+
+
+
+```ruby
+class XXXService < DefaultRest
+  # override（option）
+  def default_options
+    # 默认的参数
+    {
+        timeout: 5,
+        retry_times: 5,
+        response_json: true,
+        params_to_json: true,
+        ensure_no_exception: false,
+        header: { content_type: :json, accept: :json },
+        other_base_execute_option: {},
+        exception_with_response: true
+    }
+  end
+
+  # override (must)
+  def basic_url
+    # 填写基础版本的url
+  end
+
+  #override (option)
+  def base_params
+    # 默认每次提交时候附带的默认参数
+    {}
+  end
+end
+```

data/api_tools.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["atpking"]
   spec.email         = ["atpking@gmail.com"]
 
-  spec.summary       = '常用工具集合'
-  spec.description   = '常用工具都放这里了'
+  spec.summary       = 'rest 的常用请求'
+  spec.description   = '简单点'
   spec.homepage      = "http://jicheng1014.cnblogs.com"
   spec.license       = "MIT"
 
@@ -24,13 +24,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "webmock"
+  #spec.add_development_dependency "byebug"
+  # spec.add_development_dependency "webmock"
 
-  spec.add_dependency "oj", '> 2.0'
-  spec.add_dependency "rest-client", '> 2.0'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency "rest-client", '~> 2.0'
 end

data/lib/api_tools/default_rest.rb

@@ -1,114 +1,10 @@
 require_relative '../vendors/hash'
+require_relative './default_rest_module.rb'
 require 'json'
 require 'uri'
 require 'rest-client'
-require 'oj'
+require 'multi_json'
 
 class DefaultRest
-  class << self
-    %w[get delete head].each do |word|
-      define_method(word) do |path, params = {}, options = {}|
-        user_params = base_params.merge(params)
-        user_options = default_options.deep_merge(options) # 这里注意一下，是深merge，hash 底下的子hash是merge
-        request_dict = build_similar_get_request(word, path, user_params, user_options)
-        basic_request(request_dict, user_options)
-      end
-    end
-
-    %w[post patch put].each do |word|
-      define_method(word) do |path, params = {}, options = {}|
-        user_params = base_params.merge(params)
-        user_options = default_options.deep_merge(options) # 这里注意一下，是深merge，hash 底下的子hash是merge
-        request_dict = build_similar_post_request(word, path, user_params, user_options)
-        basic_request(request_dict, user_options)
-      end
-    end
-
-    def build_similar_get_request(word, path, user_params, user_options)
-      # 生成类get 请求的URL
-      path_params = URI.escape(user_params.collect { |k, v| "#{k}=#{v}" }.join('&'))
-      tmp = path.include?('?') ? '&' : '?'
-      path = path + tmp + path_params
-      url = build_whole_url(path)
-      {
-        method: word,
-        url: url,
-        headers: user_options[:header],
-        timeout: user_options[:timeout]
-      }.merge(user_options[:other_base_execute_option])
-    end
-
-    def build_similar_post_request(word, path, user_params, user_options)
-      url = build_whole_url(path)
-      payload = user_options[:params_to_json] ? user_params.to_json : user_params
-      {
-        method: word,
-        url: url,
-        payload: payload,
-        headers: user_options[:header],
-        timeout: user_options[:timeout]
-      }.merge(user_options[:other_base_execute_option])
-    end
-
-    def build_whole_url(path)
-      web = basic_url
-      return web if path.length.zero?
-      return path if path.start_with?("http") # path 是一个绝对路径
-      if web[-1] == "/"
-        path = path[1..-1] if path[0] == "/"
-      else
-        path = "/#{path}" if path[0] != "/"
-      end
-      web + path
-    end
-
-    def basic_request(request_dict, user_options)
-      exception = nil
-      
-      user_options[:retry_times].times do
-        begin
-          response = ::RestClient::Request.execute(request_dict)
-          return ::Oj.load(response.body, symbol_keys: true) if user_options[:response_json]
-          return response.body
-        rescue ::RestClient::ExceptionWithResponse => ex
-          raise ex if user_options[:exception_with_response]
-          return {
-            status: false,
-            response_code: ex.response.code,
-            response_body: ex.response.body,
-            message: ex.message
-          }
-        rescue RestClient::Exception => e
-          exception = e
-          next
-        end
-      end
-      raise exception unless user_options[:ensure_no_exception]
-      {
-        status: false,
-        message: ex.message
-      }
-    end
-
-    def default_options
-      @default_options ||= {
-        timeout: 5,
-        retry_times: 5,
-        response_json: true,
-        params_to_json: true,
-        ensure_no_exception: false,
-        header: { content_type: :json, accept: :json },
-        other_base_execute_option: {},
-        exception_with_response: true
-      }
-    end
-
-    def basic_url
-      'http://www.example.com' # 子类中复写
-    end
-
-    def base_params
-      {} # 子类中复写
-    end
-  end
+  extend ApiTools::DefaultRestModule
 end

data/lib/api_tools/default_rest_module.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ApiTools
+  module DefaultRestModule
+    %w[get delete head].each do |word|
+      define_method(word) do |path, params = {}, options = {}|
+        user_params = base_params.merge(params)
+        user_options = default_options.deep_merge(options) # 这里注意一下，是深merge，hash 底下的子hash是merge
+        request_dict = build_similar_get_request(word, path, user_params, user_options)
+        basic_request(request_dict, user_options)
+      end
+    end
+
+    %w[post patch put].each do |word|
+      define_method(word) do |path, params = {}, options = {}|
+        user_params = base_params.merge(params)
+        user_options = default_options.deep_merge(options) # 这里注意一下，是深merge，hash 底下的子hash是merge
+        request_dict = build_similar_post_request(word, path, user_params, user_options)
+        basic_request(request_dict, user_options)
+      end
+    end
+
+    def build_similar_get_request(word, path, user_params, user_options)
+      # 生成类get 请求的URL
+      path_params = URI.encode_www_form(user_params)
+      tmp = path.include?('?') ? '&' : '?'
+      path = path + tmp + path_params
+      url = build_whole_url(path)
+      {
+        method: word,
+        url: url,
+        headers: user_options[:header],
+        timeout: user_options[:timeout]
+      }.merge(user_options[:other_base_execute_option])
+    end
+
+    def build_similar_post_request(word, path, user_params, user_options)
+      url = build_whole_url(path)
+      payload = user_options[:params_to_json] ? user_params.to_json : user_params
+      {
+        method: word,
+        url: url,
+        payload: payload,
+        headers: user_options[:header],
+        timeout: user_options[:timeout]
+      }.merge(user_options[:other_base_execute_option])
+    end
+
+    def build_whole_url(path)
+      web = basic_url
+      return web if path.length.zero?
+      return path if path.start_with?('http') # path 是一个绝对路径
+
+      if web[-1] == '/'
+        path = path[1..-1] if path[0] == '/'
+      else
+        path = "/#{path}" if path[0] != '/'
+      end
+      web + path
+    end
+
+    def basic_request(request_dict, user_options)
+      exception = nil
+      user_options[:retry_times].times do
+        begin
+          response = ::RestClient::Request.execute(request_dict)
+          return MultiJson.load(response.body, symbolize_keys: true) if user_options[:response_json]
+
+          return response.body
+        rescue RestClient::Exception => e
+          exception = e
+          next
+        end
+      end
+      puts "Restclient error, body = #{exception.response.body}" if exception.respond_to? :response
+      raise exception unless user_options[:ensure_no_exception]
+
+      {
+        status: false,
+        message: exception.message,
+        response_code: exception&.response&.code,
+        response_body: exception&.response&.body
+      }
+    end
+
+    def default_options
+      @default_options ||= {
+        timeout: 5,
+        retry_times: 5,
+        response_json: true,
+        params_to_json: true,
+        ensure_no_exception: false,
+        header: { content_type: :json, accept: :json },
+        other_base_execute_option: {},
+        exception_with_response: true
+      }
+    end
+
+    def basic_url
+      'http://www.example.com' # 子类中复写
+    end
+
+    def base_params
+      {} # 子类中复写
+    end
+  end
+end

data/lib/api_tools/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiTools
-  VERSION = "0.0.2"
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_tools
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - atpking
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,76 +53,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: multi_json
   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: 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: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 常用工具都放这里了
+description: 简单点
 email:
 - atpking@gmail.com
 executables: []
@@ -142,13 +100,14 @@ files:
 - bin/setup
 - lib/api_tools.rb
 - lib/api_tools/default_rest.rb
+- lib/api_tools/default_rest_module.rb
 - lib/api_tools/version.rb
 - lib/vendors/hash.rb
 homepage: http://jicheng1014.cnblogs.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,9 +122,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.7
+signing_key:
 specification_version: 4
-summary: 常用工具集合
+summary: rest 的常用请求
 test_files: []