faraday_resource 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.travis.yml +3 -0
- data/CODE_OF_CONDUCT.md +13 -0
- data/Gemfile +4 -0
- data/README.md +39 -0
- data/Rakefile +1 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/faraday_resource.gemspec +32 -0
- data/lib/faraday_resource/base.rb +212 -0
- data/lib/faraday_resource/version.rb +3 -0
- data/lib/faraday_resource.rb +19 -0
- metadata +97 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 0ee24e8eaca69c657f6d46f28bd4df8db0163c2d
|
4
|
+
data.tar.gz: 76e826f4b6ac584245b6f1b9df8071c2198da753
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e381b8a5aae7ed28d3428100e335ac1ccd9303d96055a4f2900702e6b42fa397825a565b3579b33dcbdafa780fe56c0fc07fb0eaa2119ba22327d399d25dd9ad
|
7
|
+
data.tar.gz: 3e41eb8055262d69248edbe78340236957149ea84a057c851d5483d661cd55e64e712b7cd7db0f112d65d9922a4b8571a4ad93fb57167bc32a4ebbca88971b7e
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
|
4
|
+
|
5
|
+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
|
6
|
+
|
7
|
+
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
|
8
|
+
|
9
|
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
|
10
|
+
|
11
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
|
12
|
+
|
13
|
+
This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
# FaradayResource
|
2
|
+
|
3
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/faraday_resource`. To experiment with that code, run `bin/console` for an interactive prompt.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'faraday_resource'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install faraday_resource
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
|
+
|
31
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
1. Fork it ( https://github.com/[my-github-username]/faraday_resource/fork )
|
36
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
37
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
38
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
39
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "faraday_resource"
|
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
|
data/bin/setup
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'faraday_resource/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "faraday_resource"
|
8
|
+
spec.version = FaradayResource::VERSION
|
9
|
+
spec.authors = ["wpzero"]
|
10
|
+
spec.email = ["wangping@galiumsof.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{use faraday http client to create REST resource similar to angular resource}
|
13
|
+
spec.description = %q{use faraday http client to create REST resource similar to angular resource}
|
14
|
+
spec.homepage = "https://github.com/wpzero/faraday_resource"
|
15
|
+
|
16
|
+
# Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
|
17
|
+
# delete this section to allow pushing this gem to any host.
|
18
|
+
# if spec.respond_to?(:metadata)
|
19
|
+
# spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
|
20
|
+
# else
|
21
|
+
# raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
|
22
|
+
# end
|
23
|
+
|
24
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
25
|
+
spec.bindir = "exe"
|
26
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
27
|
+
spec.require_paths = ["lib"]
|
28
|
+
|
29
|
+
spec.add_development_dependency "bundler", "~> 1.9"
|
30
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
31
|
+
spec.add_dependency "faraday"
|
32
|
+
end
|
@@ -0,0 +1,212 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
|
3
|
+
# 这个是一个给block绑定一个object的方法
|
4
|
+
class Proc
|
5
|
+
def call_with_obj(obj, *args)
|
6
|
+
m = nil
|
7
|
+
p = self
|
8
|
+
Object.class_eval do
|
9
|
+
define_method :a_temp_method_name, &p
|
10
|
+
m = instance_method :a_temp_method_name; remove_method :a_temp_method_name
|
11
|
+
end
|
12
|
+
m.bind(obj).call(*args)
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
module FaradayResource
|
17
|
+
module Base
|
18
|
+
def self.included(base)
|
19
|
+
base.extend(ClassMethods)
|
20
|
+
# 设置一个attributes来存返回的数据
|
21
|
+
base.class_eval do
|
22
|
+
attr_accessor :attributes
|
23
|
+
|
24
|
+
def initialize attrs={}
|
25
|
+
@attributes = attrs
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
class << base
|
30
|
+
attr_reader :url, :content_type, :parse, :array_parse
|
31
|
+
|
32
|
+
# 这个是base的eigenclass
|
33
|
+
eigenclass = self
|
34
|
+
|
35
|
+
define_method :eigenclass do
|
36
|
+
eigenclass
|
37
|
+
end
|
38
|
+
|
39
|
+
class << eigenclass
|
40
|
+
# self 为base的eigenclass的eigenclass
|
41
|
+
def post name, method_settings={}
|
42
|
+
# self 为base的eigenclass
|
43
|
+
inner_create_method name, :post, method_settings
|
44
|
+
end
|
45
|
+
|
46
|
+
def get name, method_settings={}
|
47
|
+
inner_create_method name, :get, method_settings
|
48
|
+
end
|
49
|
+
|
50
|
+
def put name, method_settings={}
|
51
|
+
inner_create_method name, :put, method_settings
|
52
|
+
end
|
53
|
+
|
54
|
+
def delete name, method_settings={}
|
55
|
+
inner_create_method name, :delete, method_settings
|
56
|
+
end
|
57
|
+
|
58
|
+
private
|
59
|
+
def inner_create_method name, method, method_settings
|
60
|
+
# 定义一个方法
|
61
|
+
define_method name do |settings={}|
|
62
|
+
# self 为 base
|
63
|
+
dom_url = self.url || FaradayResource.config.url
|
64
|
+
re_url = settings['url'] || settings[:url] || method_settings['url'] || method_settings[:url]
|
65
|
+
params = (method_settings['params'] || method_settings[:params] || {}).merge(settings['params'] || settings[:params] || {})
|
66
|
+
if !re_url
|
67
|
+
raise 'no relative path for the method'
|
68
|
+
end
|
69
|
+
if !dom_url
|
70
|
+
raise 'no domain path for the method'
|
71
|
+
end
|
72
|
+
# 处理url的函数
|
73
|
+
re_url = self.method(:parse_url).call re_url, params
|
74
|
+
# 组建一个faraday 的 conn
|
75
|
+
conn = Faraday.new(dom_url) do |faraday|
|
76
|
+
faraday.adapter Faraday.default_adapter
|
77
|
+
end
|
78
|
+
# 构建一个 发出一个post
|
79
|
+
response = conn.send method do |req|
|
80
|
+
req.url re_url
|
81
|
+
req.headers['Content-Type'] = settings['Content-Type'] || method_settings['Content-Type'] || self.content_type || FaradayResource.config.content_type
|
82
|
+
req.params = params
|
83
|
+
end
|
84
|
+
|
85
|
+
results = []
|
86
|
+
# 判断是否解析成array
|
87
|
+
is_array = method_settings['is_array'] || method_settings[:is_array] || settings['is_array'] || settings[:is_array]
|
88
|
+
# 这个解析成array的items
|
89
|
+
if response.status == 200
|
90
|
+
if method == :get && is_array
|
91
|
+
parse = JSON.method(:parse)
|
92
|
+
parse = self.array_parse if self.array_parse
|
93
|
+
results = parse.call(response.body).map do |item|
|
94
|
+
self.new(item)
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
# 如果要是有 is_array => true 返回 response, results
|
99
|
+
if is_array
|
100
|
+
return response, results
|
101
|
+
# 否则只返回 response
|
102
|
+
else
|
103
|
+
return response
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
108
|
+
|
109
|
+
# post macro
|
110
|
+
def post name, method_settings={}
|
111
|
+
inner_create_method name, :post, method_settings
|
112
|
+
end
|
113
|
+
|
114
|
+
# get macro
|
115
|
+
def get name, method_settings={}
|
116
|
+
inner_create_method name, :get, method_settings
|
117
|
+
end
|
118
|
+
|
119
|
+
# put macro
|
120
|
+
def put name, method_settings={}
|
121
|
+
inner_create_method name, :put, method_settings
|
122
|
+
end
|
123
|
+
|
124
|
+
# delete macro
|
125
|
+
def delete name, method_settings={}
|
126
|
+
inner_create_method name, :delete, method_settings
|
127
|
+
end
|
128
|
+
|
129
|
+
# array method 返回的是array[resource]
|
130
|
+
def array_method &block
|
131
|
+
# self 是 base
|
132
|
+
block.call_with_obj(self.eigenclass)
|
133
|
+
end
|
134
|
+
|
135
|
+
private
|
136
|
+
def inner_create_method name, method, method_settings
|
137
|
+
# 定义一个方法
|
138
|
+
define_method name do |settings={}|
|
139
|
+
dom_url = self.class.url || FaradayResource.config.url
|
140
|
+
re_url = settings['url'] || settings[:url] || method_settings['url'] || method_settings[:url]
|
141
|
+
params = (method_settings['params'] || method_settings[:params] || {}).merge(settings['params'] || settings[:params] || {})
|
142
|
+
if !re_url
|
143
|
+
raise 'no relative path for the method'
|
144
|
+
end
|
145
|
+
if !dom_url
|
146
|
+
raise 'no domain path for the method'
|
147
|
+
end
|
148
|
+
# 处理url的函数
|
149
|
+
re_url = self.class.method(:parse_url).call re_url, params
|
150
|
+
# 组建一个faraday 的 conn
|
151
|
+
conn = Faraday.new(dom_url) do |faraday|
|
152
|
+
faraday.adapter Faraday.default_adapter
|
153
|
+
end
|
154
|
+
# 构建一个 发出一个post
|
155
|
+
response = conn.send method do |req|
|
156
|
+
req.url re_url
|
157
|
+
req.headers['Content-Type'] = settings['Content-Type'] || method_settings['Content-Type'] || self.class.content_type || FaradayResource.config.content_type
|
158
|
+
req.params = params
|
159
|
+
end
|
160
|
+
|
161
|
+
if response.status == 200
|
162
|
+
if method == :get || method == :post || method == :put
|
163
|
+
parse = JSON.method(:parse)
|
164
|
+
parse = self.class.parse if self.class.parse
|
165
|
+
self.attributes = parse.call(response.body)
|
166
|
+
end
|
167
|
+
end
|
168
|
+
return response
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
# 处理url
|
173
|
+
def parse_url url, options
|
174
|
+
url.gsub /:(\w+)/ do |str|
|
175
|
+
options[:"#{$1}"] || options["#{$1}"] || ''
|
176
|
+
end
|
177
|
+
end
|
178
|
+
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|
182
|
+
|
183
|
+
module ClassMethods
|
184
|
+
# 设置url
|
185
|
+
def set_url url
|
186
|
+
self.instance_eval do
|
187
|
+
@url = url
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
191
|
+
# 设置content_type
|
192
|
+
def set_content_type content_type
|
193
|
+
self.instance_eval do
|
194
|
+
@content_type = content_type
|
195
|
+
end
|
196
|
+
end
|
197
|
+
|
198
|
+
# set parse method
|
199
|
+
def set_parse &block
|
200
|
+
self.instance_eval do
|
201
|
+
@parse = block
|
202
|
+
end
|
203
|
+
end
|
204
|
+
|
205
|
+
def set_array_parse &block
|
206
|
+
self.instance_eval do
|
207
|
+
@array_parse = block
|
208
|
+
end
|
209
|
+
end
|
210
|
+
|
211
|
+
end
|
212
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require "faraday_resource/version"
|
2
|
+
|
3
|
+
module FaradayResource
|
4
|
+
class << self
|
5
|
+
attr_reader :config
|
6
|
+
|
7
|
+
def configure
|
8
|
+
@config = FaradayResourceConfig.instance
|
9
|
+
yield(@config) if block_given?
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
class FaradayResourceConfig
|
14
|
+
attr_accessor :url, :content_type
|
15
|
+
include Singleton
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
require 'faraday_resource/base'
|
metadata
ADDED
@@ -0,0 +1,97 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: faraday_resource
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- wpzero
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-09-10 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.9'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.9'
|
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: faraday
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: use faraday http client to create REST resource similar to angular resource
|
56
|
+
email:
|
57
|
+
- wangping@galiumsof.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- ".travis.yml"
|
64
|
+
- CODE_OF_CONDUCT.md
|
65
|
+
- Gemfile
|
66
|
+
- README.md
|
67
|
+
- Rakefile
|
68
|
+
- bin/console
|
69
|
+
- bin/setup
|
70
|
+
- faraday_resource.gemspec
|
71
|
+
- lib/faraday_resource.rb
|
72
|
+
- lib/faraday_resource/base.rb
|
73
|
+
- lib/faraday_resource/version.rb
|
74
|
+
homepage: https://github.com/wpzero/faraday_resource
|
75
|
+
licenses: []
|
76
|
+
metadata: {}
|
77
|
+
post_install_message:
|
78
|
+
rdoc_options: []
|
79
|
+
require_paths:
|
80
|
+
- lib
|
81
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
82
|
+
requirements:
|
83
|
+
- - ">="
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '0'
|
86
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - ">="
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
requirements: []
|
92
|
+
rubyforge_project:
|
93
|
+
rubygems_version: 2.4.7
|
94
|
+
signing_key:
|
95
|
+
specification_version: 4
|
96
|
+
summary: use faraday http client to create REST resource similar to angular resource
|
97
|
+
test_files: []
|