holded 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/.rspec +3 -0
- data/.travis.yml +6 -0
- data/CHANGELOG.md +0 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +34 -0
- data/LICENSE.txt +21 -0
- data/README.md +44 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/holded.gemspec +27 -0
- data/lib/exceptions/exceptions.rb +3 -0
- data/lib/holded.rb +8 -0
- data/lib/holded/api_request.rb +91 -0
- data/lib/holded/request.rb +63 -0
- data/lib/holded/response.rb +21 -0
- data/lib/holded/version.rb +3 -0
- metadata +65 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 39bfd881002f560a67f0e1cd204b7476b3fd5777dc6c70766da4a3d5de13a2ce
|
4
|
+
data.tar.gz: 80e26038131839149ff3ebc8c84579cdfabc38283f894b9474e4946761d2a7d8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 88afbc5ad40bc03ff610f33c3e089460f6d21f0899e8f4484958ea78efcc7f6d59e99b9014903d026cf902e4ec0b6f430c4f22084beabfc5ce9aae0466f7d0f5
|
7
|
+
data.tar.gz: 492bd0de0c614c7cc05fd14166a6776982aec6e6ea71637a420e5bf8bc6ba0c0a4c9a8a0da30f8046ee8c4c7babb6b3c52a2057953e346a7e35663a5402caa99
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CHANGELOG.md
ADDED
File without changes
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -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 anton.casais@softwhisper.es. 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 [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
holded (0.1.0)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
diff-lcs (1.4.4)
|
10
|
+
rake (12.3.3)
|
11
|
+
rspec (3.9.0)
|
12
|
+
rspec-core (~> 3.9.0)
|
13
|
+
rspec-expectations (~> 3.9.0)
|
14
|
+
rspec-mocks (~> 3.9.0)
|
15
|
+
rspec-core (3.9.2)
|
16
|
+
rspec-support (~> 3.9.3)
|
17
|
+
rspec-expectations (3.9.2)
|
18
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
19
|
+
rspec-support (~> 3.9.0)
|
20
|
+
rspec-mocks (3.9.1)
|
21
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
22
|
+
rspec-support (~> 3.9.0)
|
23
|
+
rspec-support (3.9.3)
|
24
|
+
|
25
|
+
PLATFORMS
|
26
|
+
ruby
|
27
|
+
|
28
|
+
DEPENDENCIES
|
29
|
+
holded!
|
30
|
+
rake (~> 12.0)
|
31
|
+
rspec (~> 3.0)
|
32
|
+
|
33
|
+
BUNDLED WITH
|
34
|
+
2.1.4
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2020 Antón
|
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,44 @@
|
|
1
|
+
# Holded
|
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/holded`. 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 'holded'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle install
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install holded
|
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 `rake spec` to run the tests. You can also 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`, which will 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
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/holded. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/holded/blob/master/CODE_OF_CONDUCT.md).
|
36
|
+
|
37
|
+
|
38
|
+
## License
|
39
|
+
|
40
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
41
|
+
|
42
|
+
## Code of Conduct
|
43
|
+
|
44
|
+
Everyone interacting in the Holded project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/acasaism/holded/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "holded"
|
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
data/holded.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
require_relative 'lib/holded/version'
|
2
|
+
|
3
|
+
Gem::Specification.new do |spec|
|
4
|
+
spec.name = "holded"
|
5
|
+
spec.version = Holded::VERSION
|
6
|
+
spec.authors = ["Antón Casais"]
|
7
|
+
spec.email = ["anton.casais.mera@gmail.com"]
|
8
|
+
|
9
|
+
spec.summary = "Holded Gem"
|
10
|
+
spec.description = "Holded Gem"
|
11
|
+
spec.homepage = "https://github.com/acasaism"
|
12
|
+
spec.license = "MIT"
|
13
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
|
14
|
+
|
15
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
16
|
+
spec.metadata["source_code_uri"] = "https://github.com/acasaism/holded"
|
17
|
+
spec.metadata["changelog_uri"] = "https://github.com/acasaism/holded/main/CHANGELOG.md"
|
18
|
+
|
19
|
+
# Specify which files should be added to the gem when it is released.
|
20
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
21
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
22
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
23
|
+
end
|
24
|
+
spec.bindir = "exe"
|
25
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
26
|
+
spec.require_paths = ["lib"]
|
27
|
+
end
|
data/lib/holded.rb
ADDED
@@ -0,0 +1,91 @@
|
|
1
|
+
require 'json'
|
2
|
+
require 'uri'
|
3
|
+
require 'net/http'
|
4
|
+
require 'openssl'
|
5
|
+
|
6
|
+
module Holded
|
7
|
+
class APIRequest
|
8
|
+
|
9
|
+
BASE_API_URL = 'https://api.holded.com/api/'
|
10
|
+
|
11
|
+
def initialize(builder:)
|
12
|
+
@request_builder = builder
|
13
|
+
@url = build_api_url
|
14
|
+
@http = build_http
|
15
|
+
end
|
16
|
+
|
17
|
+
def get(params: nil)
|
18
|
+
validate_api_key
|
19
|
+
request = Net::HTTP::Get.new(@url, build_headers)
|
20
|
+
request = configure_request(request: request, params: params)
|
21
|
+
response = @http.request(request)
|
22
|
+
parse_response(response: response)
|
23
|
+
end
|
24
|
+
|
25
|
+
def post(params: nil)
|
26
|
+
validate_api_key
|
27
|
+
request = Net::HTTP::Post.new(@url, build_headers)
|
28
|
+
request = configure_request(request: request, params: params)
|
29
|
+
response = @http.request(request)
|
30
|
+
parse_response(response: response)
|
31
|
+
end
|
32
|
+
|
33
|
+
def put(params: nil)
|
34
|
+
validate_api_key
|
35
|
+
request = Net::HTTP::Put.new(@url, build_headers)
|
36
|
+
request = configure_request(request: request, params: params)
|
37
|
+
response = @http.request(request)
|
38
|
+
parse_response(response: response)
|
39
|
+
end
|
40
|
+
|
41
|
+
def delete(params: nil)
|
42
|
+
validate_api_key
|
43
|
+
request = Net::HTTP::Delete.new(@url, build_headers)
|
44
|
+
request = configure_request(request: request, params: params)
|
45
|
+
response = @http.request(request)
|
46
|
+
parse_response(response: response)
|
47
|
+
end
|
48
|
+
|
49
|
+
|
50
|
+
private
|
51
|
+
|
52
|
+
def build_api_url
|
53
|
+
URI(BASE_API_URL + @request_builder.path)
|
54
|
+
end
|
55
|
+
|
56
|
+
def build_http
|
57
|
+
http = Net::HTTP.new(@url.host, @url.port)
|
58
|
+
http.use_ssl = true
|
59
|
+
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
|
60
|
+
http
|
61
|
+
end
|
62
|
+
|
63
|
+
def build_headers
|
64
|
+
{
|
65
|
+
"key" => api_key,
|
66
|
+
"Content-Type" => "application/json"
|
67
|
+
}
|
68
|
+
end
|
69
|
+
|
70
|
+
def configure_request(request:, params: nil)
|
71
|
+
request.body = params.to_json if params
|
72
|
+
request
|
73
|
+
end
|
74
|
+
|
75
|
+
def parse_response(response:)
|
76
|
+
Response.new(request_response: response)
|
77
|
+
end
|
78
|
+
|
79
|
+
protected
|
80
|
+
|
81
|
+
def validate_api_key
|
82
|
+
api_key = self.api_key
|
83
|
+
raise Exceptions::APIKeyNotFoundError, 'You must set an api_key' unless api_key
|
84
|
+
end
|
85
|
+
|
86
|
+
def api_key
|
87
|
+
@request_builder.api_key
|
88
|
+
end
|
89
|
+
|
90
|
+
end
|
91
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
module Holded
|
2
|
+
class Request
|
3
|
+
|
4
|
+
attr_accessor :api_key
|
5
|
+
|
6
|
+
def initialize(api_key: nil, api_version: 'v1')
|
7
|
+
@path_parts = []
|
8
|
+
@api_key = api_key || self.class.api_key || ENV['HOLDED_API_KEY']
|
9
|
+
@api_version = api_version
|
10
|
+
end
|
11
|
+
|
12
|
+
##
|
13
|
+
# Si el method no está definido lo extraemos y lo incluimos en el path
|
14
|
+
# si tiene argumentos los añadimos al path
|
15
|
+
#
|
16
|
+
# Ejemplo:
|
17
|
+
# Holded::Request.new.contacts.create
|
18
|
+
# 'contacts' será parte del path_parts
|
19
|
+
# #
|
20
|
+
|
21
|
+
def method_missing(method, *args)
|
22
|
+
@path_parts << method.to_s.gsub("_", "-").downcase
|
23
|
+
@path_parts << args if args.length > 0
|
24
|
+
@path_parts << @api_version if @path_parts.length == 1
|
25
|
+
self
|
26
|
+
end
|
27
|
+
|
28
|
+
def path
|
29
|
+
@path_parts.join('/')
|
30
|
+
end
|
31
|
+
|
32
|
+
def create(params: nil)
|
33
|
+
APIRequest.new(builder: self).post(params: params)
|
34
|
+
ensure
|
35
|
+
reset_path_parts
|
36
|
+
end
|
37
|
+
|
38
|
+
def update(params: nil, body: nil)
|
39
|
+
APIRequest.new(builder: self).put(params: params)
|
40
|
+
ensure
|
41
|
+
reset_path_parts
|
42
|
+
end
|
43
|
+
|
44
|
+
def search(params: nil)
|
45
|
+
APIRequest.new(builder: self).get(params: params)
|
46
|
+
ensure
|
47
|
+
reset_path_parts
|
48
|
+
end
|
49
|
+
|
50
|
+
def delete(params: nil)
|
51
|
+
APIRequest.new(builder: self).delete(params: params)
|
52
|
+
ensure
|
53
|
+
reset_path_parts
|
54
|
+
end
|
55
|
+
|
56
|
+
protected
|
57
|
+
|
58
|
+
def reset_path_parts
|
59
|
+
@path_parts = []
|
60
|
+
end
|
61
|
+
|
62
|
+
end
|
63
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
require 'json'
|
2
|
+
|
3
|
+
module Holded
|
4
|
+
class Response
|
5
|
+
attr_accessor :status_code
|
6
|
+
|
7
|
+
def initialize(request_response:)
|
8
|
+
@request_response = request_response
|
9
|
+
@status_code = request_response.code
|
10
|
+
end
|
11
|
+
|
12
|
+
def body
|
13
|
+
JSON.parse(@request_response.body)
|
14
|
+
end
|
15
|
+
|
16
|
+
def success?
|
17
|
+
@request_response.kind_of? Net::HTTPSuccess
|
18
|
+
end
|
19
|
+
|
20
|
+
end
|
21
|
+
end
|
metadata
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: holded
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Antón Casais
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-10-14 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description: Holded Gem
|
14
|
+
email:
|
15
|
+
- anton.casais.mera@gmail.com
|
16
|
+
executables: []
|
17
|
+
extensions: []
|
18
|
+
extra_rdoc_files: []
|
19
|
+
files:
|
20
|
+
- ".gitignore"
|
21
|
+
- ".rspec"
|
22
|
+
- ".travis.yml"
|
23
|
+
- CHANGELOG.md
|
24
|
+
- CODE_OF_CONDUCT.md
|
25
|
+
- Gemfile
|
26
|
+
- Gemfile.lock
|
27
|
+
- LICENSE.txt
|
28
|
+
- README.md
|
29
|
+
- Rakefile
|
30
|
+
- bin/console
|
31
|
+
- bin/setup
|
32
|
+
- holded.gemspec
|
33
|
+
- lib/exceptions/exceptions.rb
|
34
|
+
- lib/holded.rb
|
35
|
+
- lib/holded/api_request.rb
|
36
|
+
- lib/holded/request.rb
|
37
|
+
- lib/holded/response.rb
|
38
|
+
- lib/holded/version.rb
|
39
|
+
homepage: https://github.com/acasaism
|
40
|
+
licenses:
|
41
|
+
- MIT
|
42
|
+
metadata:
|
43
|
+
homepage_uri: https://github.com/acasaism
|
44
|
+
source_code_uri: https://github.com/acasaism/holded
|
45
|
+
changelog_uri: https://github.com/acasaism/holded/main/CHANGELOG.md
|
46
|
+
post_install_message:
|
47
|
+
rdoc_options: []
|
48
|
+
require_paths:
|
49
|
+
- lib
|
50
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: 2.3.0
|
55
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
56
|
+
requirements:
|
57
|
+
- - ">="
|
58
|
+
- !ruby/object:Gem::Version
|
59
|
+
version: '0'
|
60
|
+
requirements: []
|
61
|
+
rubygems_version: 3.0.6
|
62
|
+
signing_key:
|
63
|
+
specification_version: 4
|
64
|
+
summary: Holded Gem
|
65
|
+
test_files: []
|