kirin_http 0.1.0

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
+ SHA256:
3
+ metadata.gz: f38178916012eec66ddf3d608517c45224431f6a187291f04dbb8e420f43093b
4
+ data.tar.gz: 91d693248337ccddb5a74143df44eb3c5a641c36645357548c23af698cb413bc
5
+ SHA512:
6
+ metadata.gz: bb1df63a4976c643748768ff487c252064b9af476b3c96b8149db06ffe1bbd01b0817db926acfde07ecc54ec2c4bd516f083410295ce5a998e36a65f384dc904
7
+ data.tar.gz: 4f9651a9c8f6c4459238ed2f7b015a60f4171b7386b31b90e8fb34e3adc101fc7483d34616106a1ef2b97196cc35180e57c5e27c1ac3a919a2a08a7b791b7c2d
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ .idea/*
10
+ !.idea/runConfigurations
11
+ !.idea/*.iml
12
+ !.idea/*.xml
13
+ .idea/workspace.xml
14
+ .idea/vcs.xml
15
+ # rspec failure tracking
16
+ .rspec_status
17
+ *.gem
data/.gitlab-ci.yml ADDED
@@ -0,0 +1,37 @@
1
+ stages:
2
+ - test
3
+ - build
4
+ - publish
5
+
6
+ Unit Test:
7
+ tags:
8
+ - kirinnee
9
+ stage: test
10
+ script:
11
+ - bundle install
12
+ - bundle exec rspec
13
+ Build:
14
+ tags:
15
+ - ruby
16
+ - kirinnee
17
+ stage: build
18
+ script: gem build $GEM_NAME
19
+ artifacts:
20
+ paths:
21
+ - ./*.gem
22
+ Publish:
23
+ tags:
24
+ - ruby
25
+ - kirinnee
26
+ stage: publish
27
+ script:
28
+ - mkdir ~/.gem
29
+ - "echo \":rubygems_api_key: $API_KEY\" > ~/.gem/credentials"
30
+ - chmod 0600 ~/.gem/credentials
31
+ - gem push $GEM_NAME-*.gem
32
+ after_script:
33
+ - shred -vfu ~/.gem/credentials
34
+ only:
35
+ - /v[0-9\.]*/
36
+ except:
37
+ - branches
@@ -0,0 +1,4 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="Encoding" addBOMForNewFiles="with NO BOM" />
4
+ </project>
@@ -0,0 +1,55 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <module type="RUBY_MODULE" version="4">
3
+ <component name="ModuleRunConfigurationManager">
4
+ <shared>
5
+ <configuration default="false" name="Unit Test" type="RSpecRunConfigurationType" factoryName="RSpec" singleton="false">
6
+ <module name="kirin_http" />
7
+ <predefined_log_file enabled="true" id="RUBY_RSPEC" />
8
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="" />
9
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="WORK DIR" VALUE="" />
10
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SHOULD_USE_SDK" VALUE="false" />
11
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="ALTERN_SDK_NAME" VALUE="" />
12
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="myPassParentEnvs" VALUE="true" />
13
+ <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="false" />
14
+ <EXTENSION ID="JRubyRunConfigurationExtension" NailgunExecEnabled="false" />
15
+ <EXTENSION ID="RubyCoverageRunConfigurationExtension" track_test_folders="true" runner="rcov" />
16
+ <EXTENSION ID="net.ashald.envfile">
17
+ <option name="IS_ENABLED" value="false" />
18
+ <option name="IS_SUBST" value="false" />
19
+ <option name="IS_PATH_MACRO_SUPPORTED" value="false" />
20
+ <option name="IS_IGNORE_MISSING_FILES" value="false" />
21
+ <ENTRIES>
22
+ <ENTRY IS_ENABLED="true" PARSER="runconfig" />
23
+ </ENTRIES>
24
+ </EXTENSION>
25
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TESTS_FOLDER_PATH" VALUE="$MODULE_DIR$/spec" />
26
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="" />
27
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
28
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="" />
29
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="" />
30
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="ALL_IN_FOLDER" />
31
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
32
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
33
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="USE_CUSTOM_SPEC_RUNNER" VALUE="false" />
34
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="DRB" VALUE="false" />
35
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="ZEUS" VALUE="false" />
36
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPRING" VALUE="false" />
37
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="false" />
38
+ <method v="2" />
39
+ </configuration>
40
+ </shared>
41
+ </component>
42
+ <component name="NewModuleRootManager">
43
+ <content url="file://$MODULE_DIR$" />
44
+ <orderEntry type="inheritedJdk" />
45
+ <orderEntry type="sourceFolder" forTests="false" />
46
+ <orderEntry type="library" scope="PROVIDED" name="bundler (v1.17.2, ruby-2.6.0-p0) [gem]" level="application" />
47
+ <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.3, ruby-2.6.0-p0) [gem]" level="application" />
48
+ <orderEntry type="library" scope="PROVIDED" name="rake (v10.5.0, ruby-2.6.0-p0) [gem]" level="application" />
49
+ <orderEntry type="library" scope="PROVIDED" name="rspec (v3.8.0, ruby-2.6.0-p0) [gem]" level="application" />
50
+ <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.8.0, ruby-2.6.0-p0) [gem]" level="application" />
51
+ <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.8.2, ruby-2.6.0-p0) [gem]" level="application" />
52
+ <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.8.0, ruby-2.6.0-p0) [gem]" level="application" />
53
+ <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.8.0, ruby-2.6.0-p0) [gem]" level="application" />
54
+ </component>
55
+ </module>
data/.idea/misc.xml ADDED
@@ -0,0 +1,7 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="JavaScriptSettings">
4
+ <option name="languageLevel" value="ES6" />
5
+ </component>
6
+ <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.6.0-p0" project-jdk-type="RUBY_SDK" />
7
+ </project>
data/.idea/modules.xml ADDED
@@ -0,0 +1,8 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="ProjectModuleManager">
4
+ <modules>
5
+ <module fileurl="file://$PROJECT_DIR$/.idea/kirin_http.iml" filepath="$PROJECT_DIR$/.idea/kirin_http.iml" />
6
+ </modules>
7
+ </component>
8
+ </project>
@@ -0,0 +1,37 @@
1
+ <component name="ProjectRunConfigurationManager">
2
+ <configuration default="false" name="Unit Test" type="RSpecRunConfigurationType" factoryName="RSpec" singleton="false">
3
+ <module name="kirin_http" />
4
+ <predefined_log_file enabled="true" id="RUBY_RSPEC" />
5
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="" />
6
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="WORK DIR" VALUE="" />
7
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SHOULD_USE_SDK" VALUE="false" />
8
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="ALTERN_SDK_NAME" VALUE="" />
9
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="myPassParentEnvs" VALUE="true" />
10
+ <EXTENSION ID="BundlerRunConfigurationExtension" bundleExecEnabled="false" />
11
+ <EXTENSION ID="JRubyRunConfigurationExtension" NailgunExecEnabled="false" />
12
+ <EXTENSION ID="RubyCoverageRunConfigurationExtension" track_test_folders="true" runner="rcov" />
13
+ <EXTENSION ID="net.ashald.envfile">
14
+ <option name="IS_ENABLED" value="false" />
15
+ <option name="IS_SUBST" value="false" />
16
+ <option name="IS_PATH_MACRO_SUPPORTED" value="false" />
17
+ <option name="IS_IGNORE_MISSING_FILES" value="false" />
18
+ <ENTRIES>
19
+ <ENTRY IS_ENABLED="true" PARSER="runconfig" />
20
+ </ENTRIES>
21
+ </EXTENSION>
22
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TESTS_FOLDER_PATH" VALUE="$MODULE_DIR$/spec" />
23
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="" />
24
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
25
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="" />
26
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="" />
27
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="ALL_IN_FOLDER" />
28
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
29
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
30
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="USE_CUSTOM_SPEC_RUNNER" VALUE="false" />
31
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="DRB" VALUE="false" />
32
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="ZEUS" VALUE="false" />
33
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPRING" VALUE="false" />
34
+ <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="false" />
35
+ <method v="2" />
36
+ </configuration>
37
+ </component>
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -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 kirinnee97@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,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}"}
4
+
5
+ # Specify your gem's dependencies in kirin_http.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,35 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ kirin_http (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ diff-lcs (1.3)
10
+ rake (10.5.0)
11
+ rspec (3.8.0)
12
+ rspec-core (~> 3.8.0)
13
+ rspec-expectations (~> 3.8.0)
14
+ rspec-mocks (~> 3.8.0)
15
+ rspec-core (3.8.0)
16
+ rspec-support (~> 3.8.0)
17
+ rspec-expectations (3.8.2)
18
+ diff-lcs (>= 1.2.0, < 2.0)
19
+ rspec-support (~> 3.8.0)
20
+ rspec-mocks (3.8.0)
21
+ diff-lcs (>= 1.2.0, < 2.0)
22
+ rspec-support (~> 3.8.0)
23
+ rspec-support (3.8.0)
24
+
25
+ PLATFORMS
26
+ x64-mingw32
27
+
28
+ DEPENDENCIES
29
+ bundler (~> 1.17)
30
+ kirin_http!
31
+ rake (~> 10.0)
32
+ rspec (~> 3.0)
33
+
34
+ BUNDLED WITH
35
+ 1.17.2
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 kirinnee
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,98 @@
1
+ # KirinHttp
2
+
3
+ Simple HTTP Wrapper that uses HttpMessage objects and HttpResponse object to interact with REST API.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'kirin_http'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install kirin_http
20
+
21
+ ## Usage
22
+
23
+ #### Create a HTTP Message
24
+
25
+ To send a HTTP request, firstly we have to make a Message object of the class `KirinHttp::Message`.
26
+
27
+ This class consists of the `endpoint`, `content`, `method` and `header`
28
+
29
+ |Field | Description | Example Value |
30
+ |--- | --- | --- |
31
+ |endpoint | the endpoint the Http request needs to query. | `https://host.com/api/key/5?name=john` |
32
+ |content | any type of content, from json to bytes | `IO.binread "a.png"` `{"id":5,"name":"john"}.to_json` |
33
+ |method | the HTTP verb to use. It has be in symbols | `:get` `:put` `:post` `:patch` `:head` `:delete` |
34
+ |header | the headers of the HTTP as a hash object |`{"Content-Type":"application/json", "Accept": "plain/text" }` |
35
+
36
+ Example:
37
+
38
+ ```ruby
39
+ require "kirin_http"
40
+
41
+ endpoint = "https://host.com/api/todo/5?name=john"
42
+ content = {"id":5, "name": "john"}
43
+ header = {"Content-Type":"application/json", "Accept":"plain/text"}
44
+ message = KirinHttp::Message.new endpoint, :post, content, header # Obtained message object
45
+ p message
46
+ ```
47
+
48
+ #### Sending HTTP Message and obtaining response
49
+
50
+ To send a HTTP Message you created, you will need a `HttpClient`. In this library, we provided a `BasicClient`,
51
+ which is simply a wrapper around `net/http`.
52
+
53
+ ```ruby
54
+ http = KirinHttp::BasicClient.new
55
+ resp = http.send message #obtained response
56
+ p resp
57
+
58
+ ```
59
+
60
+ To read response, there are a three attributes that you can obtain, the response header - `header`, the response
61
+ payload - `content` and the status code `code`
62
+
63
+ | Field | Description |
64
+ | --- | --- |
65
+ | header | Hash that contains response headers |
66
+ | content | content in whichever mime type promised |
67
+ | code | the status code as integer, like `404` or `200` |
68
+
69
+ ```ruby
70
+ http = KirinHttp::BasicClient.new
71
+ resp = http.send message
72
+ resp.header # Get the headers as hash
73
+ resp.content # Obtains the content of the response
74
+ resp.code #Obtains the status code
75
+ ```
76
+
77
+ ## Development
78
+
79
+ After checking out the repo, run `bin/setup` to install dependencies.
80
+ Then, run `rake spec` to run the tests. You can also run `bin/console`
81
+ for an interactive prompt that will allow you to experiment.
82
+
83
+ To install this gem onto your local machine, run `bundle exec rake install`.
84
+
85
+ ## Contributing
86
+
87
+ Bug reports and pull requests are welcome on GitLab at https://gitlab.com/ruby-gem/kirin_http.
88
+ This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
89
+ to adhere to the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
90
+
91
+ ## License
92
+
93
+ The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
94
+
95
+ ## Code of Conduct
96
+
97
+ Everyone interacting in the KirinHttpClient project’s codebases, issue trackers, chat
98
+ rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
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/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "kirin_http"
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
@@ -0,0 +1,28 @@
1
+ lib = File.expand_path("../lib", __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require "kirin_http/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "kirin_http"
7
+ spec.version = KirinHttp::VERSION
8
+ spec.authors = ["kirinnee"]
9
+ spec.email = ["kirinnee97@gmail.com"]
10
+
11
+ spec.summary = %q{Simple Wrapper over net/http for simpler HTTP interface}
12
+ spec.homepage = "https://gitlab.com/ruby-gem/kirin_http"
13
+ spec.license = "MIT"
14
+
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/})}
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_development_dependency "bundler", "~> 1.17"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "rspec", "~> 3.0"
28
+ end
@@ -0,0 +1,38 @@
1
+ module KirinHttp
2
+ class Client
3
+ # Sends the http message
4
+ # @param [Message] request the request to send
5
+ # @return [Response]
6
+ def send(request)
7
+ raise NotImplementedError
8
+ end
9
+ end
10
+
11
+ class BasicClient < Client
12
+ def send(request)
13
+ http = Net::HTTP.new request.host, request.port
14
+ http.use_ssl = request.ssl
15
+ case request.method
16
+ when :get
17
+ type = Net::HTTP::Get
18
+ when :post
19
+ type = Net::HTTP::Post
20
+ when :put
21
+ type = Net::HTTP::Put
22
+ when :patch
23
+ type = Net::HTTP::Patch
24
+ when :delete
25
+ type = Net::HTTP::Delete
26
+ when :head
27
+ type = Net::HTTP::Head
28
+ else
29
+ raise NoMethodError "Unknown HTTP verb #{request.method.to_s}"
30
+ end
31
+ req = type.new(request.path, request.header)
32
+ req.body = request.content unless request.content.nil?
33
+ resp = http.request(req)
34
+ Response.new(resp.body, resp.to_hash, resp.code)
35
+ end
36
+ end
37
+
38
+ end
@@ -0,0 +1,50 @@
1
+ module KirinHttp
2
+ class Message
3
+ attr_reader :host, :port, :path, :ssl, :header, :uri
4
+ attr_accessor :method, :content
5
+
6
+ # Constructor
7
+ #
8
+ # endpoint = "https://host.com/post/1?id=5"
9
+ # data = {"id":5, "name":"John", "country": "singapore"}
10
+ # headers = {"Content-Type": "application/json", "Accept": "text/plain"}
11
+ # message = KirinHttpClient::HttpMessage.new(endpoint, :post, data.to_json, headers)
12
+ # # Use HttpClient to send the message
13
+ #
14
+ # @param [String] url the full endpoint to query
15
+ # @param [Symbol] method the http verb. Accepted symbols :get :post :put :patch :delete :head. Default is :get
16
+ # @param [Object] content the request body. Can be any type. Defaults to nil. Put nil if there is no body
17
+ # @param [Hash] header the header of the request. Defaults to empty hash
18
+ def initialize(url, method = :get, content = nil, header = {})
19
+ uri = URI.parse(url)
20
+ @host = uri.host
21
+ @port = uri.port
22
+ @path = uri.request_uri
23
+ @ssl = uri.scheme == "https"
24
+ @header = header
25
+ @header["Host"] = uri.host
26
+ @method = method
27
+ @content = content
28
+ @uri = url
29
+ end
30
+
31
+ # Endpoint of the Http Message
32
+ # @param [String] value the endpoint in full
33
+ def url=(value)
34
+ uri = URI.parse(value)
35
+ @host = uri.host
36
+ @port = uri.port
37
+ @path = uri.request_uri
38
+ @ssl = uri.scheme == "https"
39
+ @uri = value
40
+ @header["Host"] = uri.host
41
+ end
42
+
43
+ # Header of the HttpMessage
44
+ # @param [Hash] value the header
45
+ def header=(value)
46
+ @header = value
47
+ @header["Host"] = @host
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,34 @@
1
+ class Response
2
+
3
+ # @param [Object] content the body of the http request
4
+ # @param [Hash] headers the headers of the http request
5
+ # @param [Integer] code the status code of the http request
6
+ def initialize(content, headers, code)
7
+ @content = content
8
+ @header = headers
9
+ @code = code
10
+ end
11
+
12
+ # Gets the content of the Http Request made.
13
+ # This can be any type, please check headers for Content-Type to verify
14
+ #
15
+ # @return [Object]
16
+ def content
17
+ @content
18
+ end
19
+
20
+ # Returns the header as hash
21
+ #
22
+ # @return [Hash]
23
+ def header
24
+ @header
25
+ end
26
+
27
+ # Returns the status code as integer
28
+ #
29
+ # @return [Integer]
30
+ def code
31
+ @code
32
+ end
33
+
34
+ end
@@ -0,0 +1,3 @@
1
+ module KirinHttp
2
+ VERSION = "0.1.0"
3
+ end
data/lib/kirin_http.rb ADDED
@@ -0,0 +1,7 @@
1
+ require "kirin_http/version"
2
+ require "kirin_http/http_response"
3
+ require "kirin_http/http_message"
4
+ require "kirin_http/http_client"
5
+
6
+ module KirinHttp
7
+ end
metadata ADDED
@@ -0,0 +1,107 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kirin_http
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - kirinnee
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-03-04 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.17'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.17'
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
+ description:
56
+ email:
57
+ - kirinnee97@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".gitlab-ci.yml"
64
+ - ".idea/encodings.xml"
65
+ - ".idea/kirin_http.iml"
66
+ - ".idea/misc.xml"
67
+ - ".idea/modules.xml"
68
+ - ".idea/runConfigurations/Unit_Test.xml"
69
+ - ".rspec"
70
+ - CODE_OF_CONDUCT.md
71
+ - Gemfile
72
+ - Gemfile.lock
73
+ - LICENSE.txt
74
+ - README.md
75
+ - Rakefile
76
+ - bin/console
77
+ - bin/setup
78
+ - kirin_http.gemspec
79
+ - lib/kirin_http.rb
80
+ - lib/kirin_http/http_client.rb
81
+ - lib/kirin_http/http_message.rb
82
+ - lib/kirin_http/http_response.rb
83
+ - lib/kirin_http/version.rb
84
+ homepage: https://gitlab.com/ruby-gem/kirin_http
85
+ licenses:
86
+ - MIT
87
+ metadata: {}
88
+ post_install_message:
89
+ rdoc_options: []
90
+ require_paths:
91
+ - lib
92
+ required_ruby_version: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ required_rubygems_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - ">="
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ requirements: []
103
+ rubygems_version: 3.0.1
104
+ signing_key:
105
+ specification_version: 4
106
+ summary: Simple Wrapper over net/http for simpler HTTP interface
107
+ test_files: []