api_tools 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: aa3406721afd6f57f1b83462a997151be265af11
4
+ data.tar.gz: 460cf4014b0f3169bcbdbbeba9193dc6a0f2a94a
5
+ SHA512:
6
+ metadata.gz: da927e76d40b10541e025f17f5fbeb2a6bad913699b3062ddd0b1dbb77efd56a539ca83d8165f253528da9971d7922eb616e78e2517f6555b655a9b8fceedfea
7
+ data.tar.gz: 44fbb3456074f86dad7a622550d3be636f712be4b3443860defdf0c3170319e90491ebf1fe3ab7f0f674a5f15635020ae6be8dfbff7c0e54f5e691724b8e9b4c
data/.gitignore ADDED
@@ -0,0 +1,16 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ /coverage
11
+ .byebug_history
12
+ .tags
13
+ pkg
14
+
15
+ # rspec failure tracking
16
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.15.1
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at atpking@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,8 @@
1
+ if ENV["USING_OFFICIAL_GEM"]
2
+ source "https://rubygems.org"
3
+ else
4
+ source "https://gems.ruby-china.org"
5
+ end
6
+
7
+ # Specify your gem's dependencies in api_tools.gemspec
8
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 atpking
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,10 @@
1
+ # ApiTools
2
+ [![Build Status](https://travis-ci.org/jicheng1014/api_tools.svg?branch=master)](https://travis-ci.org/jicheng1014/api_tools)
3
+
4
+ ## 简介
5
+ 一些自用的工具
6
+ - DefaultRest, 发起默认REST
7
+
8
+
9
+ ## 使用
10
+ gem 'api_tools', :git => 'git@github.com:jicheng1014/api_tools.git'
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/api_tools.gemspec ADDED
@@ -0,0 +1,36 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "api_tools/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "api_tools"
8
+ spec.version = ApiTools::VERSION
9
+ spec.authors = ["atpking"]
10
+ spec.email = ["atpking@gmail.com"]
11
+
12
+ spec.summary = '常用工具集合'
13
+ spec.description = '常用工具都放这里了'
14
+ spec.homepage = "http://jicheng1014.cnblogs.com"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+
20
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
21
+ f.match(%r{^(test|spec|features)/})
22
+ end
23
+ spec.bindir = "exe"
24
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
25
+ spec.require_paths = ["lib"]
26
+
27
+ spec.add_development_dependency "bundler", "~> 1.15"
28
+ spec.add_development_dependency "rake", "~> 10.0"
29
+ spec.add_development_dependency "rspec", "~> 3.0"
30
+ spec.add_development_dependency "simplecov"
31
+ spec.add_development_dependency "byebug"
32
+ spec.add_development_dependency "webmock"
33
+
34
+ spec.add_dependency "oj", '> 2.0'
35
+ spec.add_dependency "rest-client", '> 2.0'
36
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "api_tools"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/api_tools.rb ADDED
@@ -0,0 +1,6 @@
1
+ require "api_tools/version"
2
+ require 'api_tools/default_rest'
3
+
4
+ module ApiTools
5
+ # Your code goes here...
6
+ end
@@ -0,0 +1,112 @@
1
+ require_relative '../vendors/hash'
2
+ require 'json'
3
+ require 'uri'
4
+ require 'rest-client'
5
+ require 'oj'
6
+
7
+ class DefaultRest
8
+ class << self
9
+ %w[get delete head].each do |word|
10
+ define_method(word) do |path, params = {}, options = {}|
11
+ user_params = base_params.merge(params)
12
+ user_options = default_options.deep_merge(options) # 这里注意一下,是深merge,hash 底下的子hash是merge
13
+ request_dict = build_similar_get_request(word, path, user_params, user_options)
14
+ basic_request(request_dict, user_options)
15
+ end
16
+ end
17
+
18
+ %w[post patch put].each do |word|
19
+ define_method(word) do |path, params = {}, options = {}|
20
+ user_params = base_params.merge(params)
21
+ user_options = default_options.deep_merge(options) # 这里注意一下,是深merge,hash 底下的子hash是merge
22
+ request_dict = build_similar_post_request(word, path, user_params, user_options)
23
+ basic_request(request_dict, user_options)
24
+ end
25
+ end
26
+
27
+ def build_similar_get_request(word, path, user_params, user_options)
28
+ # 生成类get 请求的URL
29
+ path_params = URI.escape(user_params.collect { |k, v| "#{k}=#{v}" }.join('&'))
30
+ tmp = path.include?('?') ? '&' : '?'
31
+ path = path + tmp + path_params
32
+ url = build_whole_url(path)
33
+ {
34
+ method: word,
35
+ url: url,
36
+ headers: user_options[:header],
37
+ timeout: user_options[:timeout]
38
+ }
39
+ end
40
+
41
+ def build_similar_post_request(word, path, user_params, user_options)
42
+ url = build_whole_url(path)
43
+ payload = user_options[:params_to_json] ? user_params.to_json : user_params
44
+ {
45
+ method: word,
46
+ url: url,
47
+ payload: payload,
48
+ headers: user_options[:header],
49
+ timeout: user_options[:timeout]
50
+ }
51
+ end
52
+
53
+ def build_whole_url(path)
54
+ web = basic_url
55
+ return web if path.length.zero?
56
+ return path if path.start_with?("http") # path 是一个绝对路径
57
+ if web[-1] == "/"
58
+ path = path[1..-1] if path[0] == "/"
59
+ else
60
+ path = "/#{path}" if path[0] != "/"
61
+ end
62
+ web + path
63
+ end
64
+
65
+ def basic_request(request_dict, user_options)
66
+ exception = nil
67
+ user_options[:retry_times].times do
68
+ begin
69
+ response = ::RestClient::Request.execute(request_dict)
70
+ return ::Oj.load(response.body, symbol_keys: true) if user_options[:response_json]
71
+ return response.body
72
+ rescue ::RestClient::ExceptionWithResponse => ex
73
+ raise ex if user_options[:exception_with_response]
74
+ return {
75
+ status: false,
76
+ response_code: ex.response.code,
77
+ response_body: ex.response.body,
78
+ message: ex.message
79
+ }
80
+ rescue RestClient::Exception => e
81
+ exception = e
82
+ next
83
+ end
84
+ end
85
+ raise exception unless user_options[:ensure_no_exception]
86
+ {
87
+ status: false,
88
+ message: ex.message
89
+ }
90
+ end
91
+
92
+ def default_options
93
+ @default_options ||= {
94
+ timeout: 5,
95
+ retry_times: 5,
96
+ response_json: true,
97
+ params_to_json: true,
98
+ ensure_no_exception: false,
99
+ header: { content_type: :json, accept: :json },
100
+ exception_with_response: true
101
+ }
102
+ end
103
+
104
+ def basic_url
105
+ 'http://www.example.com' # 子类中复写
106
+ end
107
+
108
+ def base_params
109
+ {} # 子类中复写
110
+ end
111
+ end
112
+ end
@@ -0,0 +1,3 @@
1
+ module ApiTools
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,39 @@
1
+ # from lib/active_support/core_ext/hash/deep_merge.rb
2
+ class Hash
3
+ # Returns a new hash with +self+ and +other_hash+ merged recursively.
4
+ #
5
+ # h1 = { a: true, b: { c: [1, 2, 3] } }
6
+ # h2 = { a: false, b: { x: [3, 4, 5] } }
7
+ #
8
+ # h1.deep_merge(h2) # => { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
9
+ #
10
+ # Like with Hash#merge in the standard library, a block can be provided
11
+ # to merge values:
12
+ #
13
+ # h1 = { a: 100, b: 200, c: { c1: 100 } }
14
+ # h2 = { b: 250, c: { c1: 200 } }
15
+ # h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
16
+ # # => { a: 100, b: 450, c: { c1: 300 } }
17
+ def deep_merge(other_hash, &block)
18
+ dup.deep_merge!(other_hash, &block)
19
+ end
20
+
21
+ # Same as +deep_merge+, but modifies +self+.
22
+ def deep_merge!(other_hash, &block)
23
+ other_hash.each_pair do |current_key, other_value|
24
+ this_value = self[current_key]
25
+
26
+ self[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
27
+ this_value.deep_merge(other_value, &block)
28
+ else
29
+ if block_given? && key?(current_key)
30
+ block.call(current_key, this_value, other_value)
31
+ else
32
+ other_value
33
+ end
34
+ end
35
+ end
36
+
37
+ self
38
+ end
39
+ end
metadata ADDED
@@ -0,0 +1,171 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: api_tools
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - atpking
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-06-22 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: simplecov
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: byebug
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: webmock
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: oj
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">"
102
+ - !ruby/object:Gem::Version
103
+ version: '2.0'
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">"
109
+ - !ruby/object:Gem::Version
110
+ version: '2.0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rest-client
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">"
116
+ - !ruby/object:Gem::Version
117
+ version: '2.0'
118
+ type: :runtime
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">"
123
+ - !ruby/object:Gem::Version
124
+ version: '2.0'
125
+ description: 常用工具都放这里了
126
+ email:
127
+ - atpking@gmail.com
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".gitignore"
133
+ - ".rspec"
134
+ - ".travis.yml"
135
+ - CODE_OF_CONDUCT.md
136
+ - Gemfile
137
+ - LICENSE.txt
138
+ - README.md
139
+ - Rakefile
140
+ - api_tools.gemspec
141
+ - bin/console
142
+ - bin/setup
143
+ - lib/api_tools.rb
144
+ - lib/api_tools/default_rest.rb
145
+ - lib/api_tools/version.rb
146
+ - lib/vendors/hash.rb
147
+ homepage: http://jicheng1014.cnblogs.com
148
+ licenses:
149
+ - MIT
150
+ metadata: {}
151
+ post_install_message:
152
+ rdoc_options: []
153
+ require_paths:
154
+ - lib
155
+ required_ruby_version: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ required_rubygems_version: !ruby/object:Gem::Requirement
161
+ requirements:
162
+ - - ">="
163
+ - !ruby/object:Gem::Version
164
+ version: '0'
165
+ requirements: []
166
+ rubyforge_project:
167
+ rubygems_version: 2.6.12
168
+ signing_key:
169
+ specification_version: 4
170
+ summary: 常用工具集合
171
+ test_files: []