-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 828ed95
Showing
10 changed files
with
173 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
root = true | ||
|
||
[*.cr] | ||
charset = utf-8 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
indent_style = space | ||
indent_size = 2 | ||
trim_trailing_whitespace = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
/docs/ | ||
/lib/ | ||
/bin/ | ||
/.shards/ | ||
*.dwarf | ||
|
||
# Libraries don't need dependency lock | ||
# Dependencies will be locked in applications that use them | ||
/shard.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
language: crystal | ||
|
||
# Uncomment the following if you'd like Travis to run specs and check code formatting | ||
# script: | ||
# - crystal spec | ||
# - crystal tool format --check |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2021 creadone <[email protected]> | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Cocoon | ||
|
||
Helper for wrap third-party API calls | ||
|
||
## Installation | ||
|
||
1. Add the dependency to your `shard.yml`: | ||
|
||
```yaml | ||
dependencies: | ||
cocoon: | ||
github: creadone/cocoon | ||
``` | ||
2. Run `shards install` | ||
|
||
## Usage | ||
|
||
```crystal | ||
require "json" | ||
require "cocoon" | ||
require "http/client" | ||
alias Response = HTTP::Client::Response | ||
cocoon = Cocoon::Wrapper(Response).new | ||
channel = cocoon.wrap do | ||
headers = HTTP::Headers{ "Accept" => "application/vnd.github.v3+json" } | ||
HTTP::Client.get "https://api.github.com/networks/crystal-lang/crystal/events", headers: headers | ||
end | ||
if resp = channel.receive | ||
if resp.is_a?(Response) && resp.success? | ||
pp JSON.parse(resp.body) | ||
elsif resp.is_a?(Exception) | ||
# log it and raise resp | ||
end | ||
end | ||
``` | ||
|
||
## Contributing | ||
|
||
1. Fork it (<https://github.com/creadone/cocoon/fork>) | ||
2. Create your feature branch (`git checkout -b my-new-feature`) | ||
3. Commit your changes (`git commit -am 'Add some feature'`) | ||
4. Push to the branch (`git push origin my-new-feature`) | ||
5. Create a new Pull Request | ||
|
||
## Contributors | ||
|
||
- [creadone](https://github.com/creadone) - creator and maintainer |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
require "json" | ||
require "../src/cocoon" | ||
require "http/client" | ||
|
||
alias Response = HTTP::Client::Response | ||
cocoon = Cocoon::Wrapper(Response).new | ||
|
||
channel = cocoon.wrap do | ||
headers = HTTP::Headers{ "Accept" => "application/vnd.github.v3+json" } | ||
HTTP::Client.get "https://api.github.com/networks/crystal-lang/crystal/events", headers: headers | ||
end | ||
|
||
if resp = channel.receive | ||
if resp.is_a?(Response) && resp.success? | ||
pp JSON.parse(resp.body) | ||
elsif resp.is_a?(Exception) | ||
# log it and raise resp | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
name: cocoon | ||
version: 0.1.0 | ||
|
||
authors: | ||
- Sergey Fedorov <[email protected]> | ||
|
||
description: | | ||
Helper for wrap third-party API calls | ||
crystal: 0.36.1 | ||
|
||
license: MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
require "./spec_helper" | ||
|
||
describe Cocoon do | ||
describe "Wrapper" do | ||
cocoon = Cocoon::Wrapper(Int32).new | ||
|
||
it "should return sum of integers" do | ||
if result = cocoon.wrap{ 1 + 3 }.receive | ||
result.should eq(4) | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
require "spec" | ||
require "../src/cocoon" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
require "http/client" | ||
|
||
module Cocoon | ||
VERSION = `shards version` | ||
|
||
class Wrapper(T) | ||
def initialize( | ||
@result = Channel(T | Exception).new, | ||
@output = Channel(T | Exception).new | ||
) | ||
end | ||
|
||
def wrap(&block : -> T) forall T | ||
spawn(name: "executor") do | ||
@result.send block.call | ||
rescue ex | ||
@result.send ex | ||
end | ||
|
||
Fiber.yield | ||
|
||
spawn(name: "receiver") do | ||
select | ||
when data = @result.receive | ||
@output.send data | ||
end | ||
end | ||
@output | ||
end | ||
end | ||
end |