darksky_ruby_client 0.0.1
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 +5 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -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/darksky_ruby_client.gemspec +29 -0
- data/exe/darksky_ruby_client +3 -0
- data/lib/darksky_ruby_client/client.rb +102 -0
- data/lib/darksky_ruby_client/version.rb +3 -0
- data/lib/darksky_ruby_client.rb +2 -0
- metadata +116 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: e465eb949a63a9ad1e90ba1465e57c9a8f2eae23
|
4
|
+
data.tar.gz: da2bc0d0149ad03dbf6cf52a7749f600d6c9334f
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 815c7adfdd5ca12e8ffcc9bf27e0ab14beab1f02216460286e89f50eab3075351bffe989102ece06b895eb68525fead36e66506e668be48f17265e6f22c40277
|
7
|
+
data.tar.gz: '008aa7d52f32ff62883228b9e94f449b2fdf5f2af43334a8d0ec362826cdb5bd28dd322ced2cfbafe29c77e19d0ef267f499c4e5827d3b7a0f29464d814531bc'
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
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 appcot.2013@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
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 appcot
|
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
|
+
# DarkskyRubyClient
|
2
|
+
This Client for more convenient use of the DarkSky API.
|
3
|
+
|
4
|
+
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/darksky_ruby_client`. To experiment with that code, run `bin/console` for an interactive prompt.
|
5
|
+
|
6
|
+
TODO: Delete this and the text above, and describe your gem
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
|
10
|
+
Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
gem 'darksky_ruby_client'
|
14
|
+
```
|
15
|
+
|
16
|
+
And then execute:
|
17
|
+
|
18
|
+
$ bundle
|
19
|
+
|
20
|
+
Or install it yourself as:
|
21
|
+
|
22
|
+
$ gem install darksky_ruby_client
|
23
|
+
|
24
|
+
## Usage
|
25
|
+
|
26
|
+
TODO: Write usage instructions here
|
27
|
+
|
28
|
+
## Development
|
29
|
+
|
30
|
+
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.
|
31
|
+
|
32
|
+
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).
|
33
|
+
|
34
|
+
## Contributing
|
35
|
+
|
36
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/darksky_ruby_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
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 DarkskyRubyClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/darksky_ruby_client/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 "darksky_ruby_client"
|
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,29 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "darksky_ruby_client/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "darksky_ruby_client"
|
8
|
+
spec.version = DarkskyRubyClient::VERSION
|
9
|
+
spec.authors = ["appcot"]
|
10
|
+
spec.email = ["appcot.2013@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{DarkSky Ruby Client}
|
13
|
+
spec.description = %q{Ruby client for the DarkSky.}
|
14
|
+
spec.homepage = "https://github.com/appcot/darksky_ruby_client"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
spec.bindir = "exe"
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
22
|
+
spec.require_paths = ["lib"]
|
23
|
+
|
24
|
+
spec.add_dependency "typhoeus", "~> 1.3"
|
25
|
+
|
26
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
27
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
28
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
29
|
+
end
|
@@ -0,0 +1,102 @@
|
|
1
|
+
require 'json'
|
2
|
+
require 'logger'
|
3
|
+
require 'typhoeus'
|
4
|
+
|
5
|
+
module DarkskyRubyClient
|
6
|
+
class Client
|
7
|
+
@@base_url = 'https://api.darksky.net/forecast/'
|
8
|
+
|
9
|
+
#TODO logger
|
10
|
+
@log = Logger.new('/tmp/log')
|
11
|
+
|
12
|
+
# Don't need this method to use until the base_url of darksky api has changed.
|
13
|
+
def base_url
|
14
|
+
@@base_url
|
15
|
+
end
|
16
|
+
|
17
|
+
# Don't need this method to use until the base_url of darksky api has changed.
|
18
|
+
def base_url=(value)
|
19
|
+
@@base_url = value
|
20
|
+
end
|
21
|
+
|
22
|
+
# Initialize
|
23
|
+
# @param [String] key Secret key of the api.
|
24
|
+
def initialize(key)
|
25
|
+
@secret_key = key
|
26
|
+
@client = Typhoeus::Request.new(@@base_url)
|
27
|
+
@options = {}
|
28
|
+
@params = {:params => {}}
|
29
|
+
end
|
30
|
+
|
31
|
+
# A single request for forecast request
|
32
|
+
# @param [String] lat The latitude of a location (in decimal degrees).
|
33
|
+
# @param [String] long The longitude of a location (in decimal degrees).
|
34
|
+
# @param [Hash] options Use if you want to specify "explicit, extend, lang, units".
|
35
|
+
# Please check https://darksky.net/dev/docs#forecast-request for details.
|
36
|
+
# @option options [String] :exclude
|
37
|
+
# exlude=[blocks] e.g. currently, flags
|
38
|
+
# Exclude some number of data blocks from the API response.
|
39
|
+
# This is useful for reducing latency and saving cache space.
|
40
|
+
# The value blocks should be a comma-delimeted list (without spaces) of any of the following:
|
41
|
+
# * currently
|
42
|
+
# * minutely
|
43
|
+
# * hourly
|
44
|
+
# * daily
|
45
|
+
# * alerts
|
46
|
+
# * flags
|
47
|
+
# @option options [String] :extend
|
48
|
+
# extend=[hourly] e.g. 24
|
49
|
+
# When present, return hour-by-hour data for the next 168 hours, instead of the next 48.
|
50
|
+
# When using this option, we strongly recommend enabling HTTP compression.
|
51
|
+
# @option options [String] :lang
|
52
|
+
# e.g. en
|
53
|
+
# Return summary properties in the desired language.
|
54
|
+
# (Note that units in the summary will be set according to the units parameter,
|
55
|
+
# so be sure to set both parameters appropriately.)
|
56
|
+
# Please check with https://darksky.net/dev/docs#forecast-request for available languages.
|
57
|
+
# @option options [String] :units
|
58
|
+
# units=[units] e.g. auto
|
59
|
+
# Return weather conditions in the requested units.
|
60
|
+
# [units] should be one of the following:
|
61
|
+
# * auto: automatically select units based on geographic location
|
62
|
+
# * ca: same as si, except that windSpeed and windGust are in kilometers per hour
|
63
|
+
# * uk2: same as si, except that nearestStormDistance and visibility are in miles,
|
64
|
+
# and windSpeed and windGust in miles per hour
|
65
|
+
# * us: Imperial units (the default)
|
66
|
+
# * si: SI units
|
67
|
+
# Please check with https://darksky.net/dev/docs#forecast-request for available SI units.
|
68
|
+
def weather_forecast(lat, long, options = {})
|
69
|
+
@request_url << @@base_url + @secret_key + '/' + lat + ',' + long + '/'
|
70
|
+
unless options.empty? then
|
71
|
+
options.each {|key, value|
|
72
|
+
if [:exclude, :extend, :lang, :units].include?(key)
|
73
|
+
p @request_url[-1]
|
74
|
+
if @request_url[-1] == '/'
|
75
|
+
@request_url << '?' + key.to_s + '=' + value
|
76
|
+
else
|
77
|
+
@request_url << '&' + key.to_s + '=' + value
|
78
|
+
end
|
79
|
+
else
|
80
|
+
@log.warn("invalid options key \"#{key}\".")
|
81
|
+
end
|
82
|
+
}
|
83
|
+
end
|
84
|
+
init_client
|
85
|
+
end
|
86
|
+
|
87
|
+
# TODO Parallel requests
|
88
|
+
def some_weather_forecast(options = {}, locations:)
|
89
|
+
|
90
|
+
end
|
91
|
+
|
92
|
+
# Init client for typhoeus
|
93
|
+
def init_client
|
94
|
+
@client = Typhoeus::Request.new(@request_url)
|
95
|
+
end
|
96
|
+
|
97
|
+
# Run a request.
|
98
|
+
def run
|
99
|
+
@client.run
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
metadata
ADDED
@@ -0,0 +1,116 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: darksky_ruby_client
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- appcot
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-11-23 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: typhoeus
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.3'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.16'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.16'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.0'
|
69
|
+
description: Ruby client for the DarkSky.
|
70
|
+
email:
|
71
|
+
- appcot.2013@gmail.com
|
72
|
+
executables:
|
73
|
+
- darksky_ruby_client
|
74
|
+
extensions: []
|
75
|
+
extra_rdoc_files: []
|
76
|
+
files:
|
77
|
+
- ".gitignore"
|
78
|
+
- ".rspec"
|
79
|
+
- ".travis.yml"
|
80
|
+
- CODE_OF_CONDUCT.md
|
81
|
+
- Gemfile
|
82
|
+
- LICENSE.txt
|
83
|
+
- README.md
|
84
|
+
- Rakefile
|
85
|
+
- bin/console
|
86
|
+
- bin/setup
|
87
|
+
- darksky_ruby_client.gemspec
|
88
|
+
- exe/darksky_ruby_client
|
89
|
+
- lib/darksky_ruby_client.rb
|
90
|
+
- lib/darksky_ruby_client/client.rb
|
91
|
+
- lib/darksky_ruby_client/version.rb
|
92
|
+
homepage: https://github.com/appcot/darksky_ruby_client
|
93
|
+
licenses:
|
94
|
+
- MIT
|
95
|
+
metadata: {}
|
96
|
+
post_install_message:
|
97
|
+
rdoc_options: []
|
98
|
+
require_paths:
|
99
|
+
- lib
|
100
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
101
|
+
requirements:
|
102
|
+
- - ">="
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: '0'
|
105
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '0'
|
110
|
+
requirements: []
|
111
|
+
rubyforge_project:
|
112
|
+
rubygems_version: 2.6.11
|
113
|
+
signing_key:
|
114
|
+
specification_version: 4
|
115
|
+
summary: DarkSky Ruby Client
|
116
|
+
test_files: []
|