espn 0.0.2

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.
@@ -0,0 +1,3 @@
1
+ .rbenv-gemsets
2
+ .ruby-version
3
+ *.gem
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source "https://rubygems.org"
2
+
3
+ gemspec
@@ -0,0 +1,65 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ espn (0.0.1)
5
+ addressable (~> 2.2)
6
+ faraday (~> 0.8)
7
+ faraday_middleware (~> 0.8)
8
+ hashie (~> 1.2)
9
+ multi_json (~> 1.3)
10
+ oauth (~> 0.4)
11
+
12
+ GEM
13
+ remote: https://rubygems.org/
14
+ specs:
15
+ addressable (2.3.3)
16
+ crack (0.3.2)
17
+ diff-lcs (1.1.3)
18
+ faraday (0.8.5)
19
+ multipart-post (~> 1.1)
20
+ faraday_middleware (0.9.0)
21
+ faraday (>= 0.7.4, < 0.9)
22
+ hashie (1.2.0)
23
+ json (1.7.7)
24
+ kramdown (0.14.2)
25
+ logutils (0.3.0)
26
+ markdown (1.0.0)
27
+ kramdown (>= 0.13.7)
28
+ props (>= 1.0.0)
29
+ textutils (>= 0.2.0)
30
+ multi_json (1.6.1)
31
+ multipart-post (1.1.5)
32
+ oauth (0.4.7)
33
+ props (1.0.0)
34
+ rake (10.0.3)
35
+ rspec (2.12.0)
36
+ rspec-core (~> 2.12.0)
37
+ rspec-expectations (~> 2.12.0)
38
+ rspec-mocks (~> 2.12.0)
39
+ rspec-core (2.12.2)
40
+ rspec-expectations (2.12.1)
41
+ diff-lcs (~> 1.1.3)
42
+ rspec-mocks (2.12.2)
43
+ simplecov (0.7.1)
44
+ multi_json (~> 1.0)
45
+ simplecov-html (~> 0.7.1)
46
+ simplecov-html (0.7.1)
47
+ textutils (0.4.0)
48
+ logutils (>= 0.3.0)
49
+ webmock (1.9.3)
50
+ addressable (>= 2.2.7)
51
+ crack (>= 0.3.2)
52
+ yard (0.8.4.1)
53
+
54
+ PLATFORMS
55
+ ruby
56
+
57
+ DEPENDENCIES
58
+ espn!
59
+ json
60
+ markdown
61
+ rake
62
+ rspec
63
+ simplecov
64
+ webmock
65
+ yard
@@ -0,0 +1,5 @@
1
+ # Ruby Wrapper for the ESPN API
2
+
3
+ ## Why?
4
+
5
+ I have seen this halfway implemented a few times. My goal is to take over the `espn` gem name.
@@ -0,0 +1,33 @@
1
+ # -*- encoding: utf-8 -*-
2
+ require File.expand_path('../lib/espn/version', __FILE__)
3
+
4
+ Gem::Specification.new do |s|
5
+ s.name = 'espn'
6
+ s.version = ESPN::VERSION
7
+ s.platform = Gem::Platform::RUBY
8
+
9
+ s.authors = ['Andrew Thorp']
10
+ s.email = ['andrewpthorp@gmail.com']
11
+ s.homepage = 'http://github.com/andrewpthorp/espn'
12
+ s.description = %q{Simple wrapper for the ESPN v1 API.}
13
+ s.summary = s.description
14
+
15
+ s.add_runtime_dependency 'addressable', '~> 2.2'
16
+ s.add_runtime_dependency 'faraday', '~> 0.8'
17
+ s.add_runtime_dependency 'faraday_middleware', '~> 0.8'
18
+ s.add_runtime_dependency 'hashie', '~> 1.2'
19
+ s.add_runtime_dependency 'multi_json', '~> 1.3'
20
+ s.add_runtime_dependency 'oauth', '~> 0.4'
21
+
22
+ s.add_development_dependency 'json'
23
+ s.add_development_dependency 'rake'
24
+ s.add_development_dependency 'rspec'
25
+ s.add_development_dependency 'simplecov'
26
+ s.add_development_dependency 'webmock'
27
+ s.add_development_dependency 'yard'
28
+ s.add_development_dependency 'markdown'
29
+
30
+ s.files = `git ls-files -cd`.split("\n")
31
+ s.test_files = Dir.glob("spec/**/*")
32
+ s.require_paths = ["lib"]
33
+ end
@@ -0,0 +1,25 @@
1
+ require 'espn/configuration'
2
+ require 'espn/client'
3
+ require 'espn/error'
4
+
5
+ module ESPN
6
+ extend Configuration
7
+ class << self
8
+ # Alias for ESPN::Client.new
9
+ #
10
+ # @return [ESPN::Client]
11
+ def new(options={})
12
+ ESPN::Client.new(options)
13
+ end
14
+
15
+ # Delegate to ESPN::Client.new
16
+ def method_missing(method, *args, &block)
17
+ return super unless new.respond_to?(method)
18
+ new.send(method, *args, &block)
19
+ end
20
+
21
+ def respond_to?(method, include_private=false)
22
+ new.respond_to?(method, include_private) || super(method, include_private)
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,39 @@
1
+ require 'espn/connection'
2
+ require 'espn/request'
3
+ require 'espn/client/sports'
4
+ require 'espn/client/teams'
5
+
6
+ module ESPN
7
+
8
+ class Client
9
+ attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
10
+
11
+ def initialize(options={})
12
+ options = ESPN.options.merge(options)
13
+ Configuration::VALID_OPTIONS_KEYS.each do |key|
14
+ send("#{key}=", options[key])
15
+ end
16
+ end
17
+
18
+ # Provides the URL for accessing the API
19
+ #
20
+ # @return [String]
21
+ def api_url
22
+ "http://api.espn.com/v1"
23
+ end
24
+
25
+ # Determine if an api_key has been set
26
+ #
27
+ # @return [Boolean]
28
+ def authed?
29
+ !api_key.nil?
30
+ end
31
+
32
+ include ESPN::Connection
33
+ include ESPN::Request
34
+ include ESPN::Client::Sports
35
+ include ESPN::Client::Teams
36
+
37
+ end
38
+
39
+ end
@@ -0,0 +1,19 @@
1
+ module ESPN
2
+ class Client
3
+ module Sports
4
+
5
+ # Get all sports supported by the ESPN Developer API
6
+ #
7
+ # @param [Hash] options
8
+ #
9
+ # @return [Hashie::Mash]
10
+ #
11
+ # @example
12
+ # ESPN.sports()
13
+ def sports(options={})
14
+ get("/sports", options)
15
+ end
16
+
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,19 @@
1
+ module ESPN
2
+ class Client
3
+ module Teams
4
+
5
+ # Get all sports supported by the ESPN Developer API
6
+ #
7
+ # @param [Hash] options
8
+ #
9
+ # @return [Hashie::Mash]
10
+ #
11
+ # @example
12
+ # ESPN.sports()
13
+ def teams(options={})
14
+ get("/sports/teams", options)
15
+ end
16
+
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,44 @@
1
+ require 'faraday'
2
+ require 'espn/version'
3
+
4
+ module ESPN
5
+ module Configuration
6
+ VALID_OPTIONS_KEYS = [
7
+ :adapter,
8
+ :api_version,
9
+ :proxy,
10
+ :api_key,
11
+ :timeout,
12
+ :open_timeout,
13
+ :user_agent].freeze
14
+
15
+ DEFAULT_ADAPTER = Faraday.default_adapter
16
+ DEFAULT_API_VERSION = 1
17
+ DEFAULT_USER_AGENT = "ESPN Ruby Gem #{ESPN::VERSION}".freeze
18
+ DEFAULT_TIMEOUT = 10
19
+
20
+ attr_accessor(*VALID_OPTIONS_KEYS)
21
+
22
+ def self.extended(base)
23
+ base.reset
24
+ end
25
+
26
+ def configure
27
+ yield self
28
+ end
29
+
30
+ def options
31
+ VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
32
+ end
33
+
34
+ def reset
35
+ self.adapter = DEFAULT_ADAPTER
36
+ self.api_version = DEFAULT_API_VERSION
37
+ self.user_agent = DEFAULT_USER_AGENT
38
+ self.timeout = DEFAULT_TIMEOUT
39
+ self.open_timeout = DEFAULT_TIMEOUT
40
+ self.api_key = nil
41
+ self.proxy = nil
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,32 @@
1
+ require 'faraday_middleware'
2
+ require 'faraday/response/raise_espn_error'
3
+
4
+ module ESPN
5
+ # @private
6
+ module Connection
7
+ private
8
+
9
+ def connection
10
+
11
+ options = {
12
+ proxy: proxy,
13
+ ssl: { verify: false },
14
+ url: api_url
15
+ }
16
+
17
+ options.merge!(params: { apikey: api_key }) if authed?
18
+
19
+ connection = Faraday.new(options) do |builder|
20
+ builder.request :url_encoded
21
+
22
+ builder.use Faraday::Response::RaiseESPNError
23
+ builder.use FaradayMiddleware::Mashify
24
+ builder.use FaradayMiddleware::ParseJson
25
+
26
+ builder.adapter adapter
27
+ end
28
+
29
+ connection
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,12 @@
1
+ module ESPN
2
+
3
+ # Custom error class for rescuing from all ESPN errors
4
+ class Error < StandardError; end
5
+
6
+ # 401 HTTP Status Code
7
+ class Unauthorized < Error; end
8
+
9
+ # 404 HTTP Status Code
10
+ class NotFound < Error; end
11
+
12
+ end
@@ -0,0 +1,22 @@
1
+ require 'multi_json'
2
+
3
+ module ESPN
4
+ module Request
5
+ def get(path, options={})
6
+ request(:get, path, options)
7
+ end
8
+
9
+ private
10
+
11
+ def request(method, path, options)
12
+ response = connection.send(method) do |request|
13
+ request.url(path, options)
14
+ request.options[:timeout] = timeout
15
+ request.options[:open_timeout] = open_timeout
16
+ end
17
+
18
+ response.body
19
+ end
20
+
21
+ end
22
+ end
@@ -0,0 +1,3 @@
1
+ module ESPN
2
+ VERSION = "0.0.2" unless defined?(ESPN::VERSION)
3
+ end
@@ -0,0 +1,28 @@
1
+ require 'faraday'
2
+ require 'multi_json'
3
+
4
+ # @api private
5
+ module Faraday
6
+ class Response::RaiseESPNError < Response::Middleware
7
+ def on_complete(response)
8
+ case response[:status].to_i
9
+ when 401
10
+ raise ESPN::Unauthorized, error_message(response)
11
+ when 404
12
+ raise ESPN::NotFound, error_message(response)
13
+ end
14
+ end
15
+
16
+ def error_message(response)
17
+ message = if (body = response[:body]) && !body.empty?
18
+ if body.is_a?(String)
19
+ body = MultiJson.load(body, :symbolize_keys => true)
20
+ end
21
+ ": #{body[:error] || body[:message] || ''}"
22
+ else
23
+ ''
24
+ end
25
+ "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}"
26
+ end
27
+ end
28
+ end
metadata ADDED
@@ -0,0 +1,269 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: espn
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.2
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Andrew Thorp
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-02-25 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: addressable
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: '2.2'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: '2.2'
30
+ - !ruby/object:Gem::Dependency
31
+ name: faraday
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ~>
36
+ - !ruby/object:Gem::Version
37
+ version: '0.8'
38
+ type: :runtime
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ~>
44
+ - !ruby/object:Gem::Version
45
+ version: '0.8'
46
+ - !ruby/object:Gem::Dependency
47
+ name: faraday_middleware
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ~>
52
+ - !ruby/object:Gem::Version
53
+ version: '0.8'
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ~>
60
+ - !ruby/object:Gem::Version
61
+ version: '0.8'
62
+ - !ruby/object:Gem::Dependency
63
+ name: hashie
64
+ requirement: !ruby/object:Gem::Requirement
65
+ none: false
66
+ requirements:
67
+ - - ~>
68
+ - !ruby/object:Gem::Version
69
+ version: '1.2'
70
+ type: :runtime
71
+ prerelease: false
72
+ version_requirements: !ruby/object:Gem::Requirement
73
+ none: false
74
+ requirements:
75
+ - - ~>
76
+ - !ruby/object:Gem::Version
77
+ version: '1.2'
78
+ - !ruby/object:Gem::Dependency
79
+ name: multi_json
80
+ requirement: !ruby/object:Gem::Requirement
81
+ none: false
82
+ requirements:
83
+ - - ~>
84
+ - !ruby/object:Gem::Version
85
+ version: '1.3'
86
+ type: :runtime
87
+ prerelease: false
88
+ version_requirements: !ruby/object:Gem::Requirement
89
+ none: false
90
+ requirements:
91
+ - - ~>
92
+ - !ruby/object:Gem::Version
93
+ version: '1.3'
94
+ - !ruby/object:Gem::Dependency
95
+ name: oauth
96
+ requirement: !ruby/object:Gem::Requirement
97
+ none: false
98
+ requirements:
99
+ - - ~>
100
+ - !ruby/object:Gem::Version
101
+ version: '0.4'
102
+ type: :runtime
103
+ prerelease: false
104
+ version_requirements: !ruby/object:Gem::Requirement
105
+ none: false
106
+ requirements:
107
+ - - ~>
108
+ - !ruby/object:Gem::Version
109
+ version: '0.4'
110
+ - !ruby/object:Gem::Dependency
111
+ name: json
112
+ requirement: !ruby/object:Gem::Requirement
113
+ none: false
114
+ requirements:
115
+ - - ! '>='
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ none: false
122
+ requirements:
123
+ - - ! '>='
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ - !ruby/object:Gem::Dependency
127
+ name: rake
128
+ requirement: !ruby/object:Gem::Requirement
129
+ none: false
130
+ requirements:
131
+ - - ! '>='
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ type: :development
135
+ prerelease: false
136
+ version_requirements: !ruby/object:Gem::Requirement
137
+ none: false
138
+ requirements:
139
+ - - ! '>='
140
+ - !ruby/object:Gem::Version
141
+ version: '0'
142
+ - !ruby/object:Gem::Dependency
143
+ name: rspec
144
+ requirement: !ruby/object:Gem::Requirement
145
+ none: false
146
+ requirements:
147
+ - - ! '>='
148
+ - !ruby/object:Gem::Version
149
+ version: '0'
150
+ type: :development
151
+ prerelease: false
152
+ version_requirements: !ruby/object:Gem::Requirement
153
+ none: false
154
+ requirements:
155
+ - - ! '>='
156
+ - !ruby/object:Gem::Version
157
+ version: '0'
158
+ - !ruby/object:Gem::Dependency
159
+ name: simplecov
160
+ requirement: !ruby/object:Gem::Requirement
161
+ none: false
162
+ requirements:
163
+ - - ! '>='
164
+ - !ruby/object:Gem::Version
165
+ version: '0'
166
+ type: :development
167
+ prerelease: false
168
+ version_requirements: !ruby/object:Gem::Requirement
169
+ none: false
170
+ requirements:
171
+ - - ! '>='
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ - !ruby/object:Gem::Dependency
175
+ name: webmock
176
+ requirement: !ruby/object:Gem::Requirement
177
+ none: false
178
+ requirements:
179
+ - - ! '>='
180
+ - !ruby/object:Gem::Version
181
+ version: '0'
182
+ type: :development
183
+ prerelease: false
184
+ version_requirements: !ruby/object:Gem::Requirement
185
+ none: false
186
+ requirements:
187
+ - - ! '>='
188
+ - !ruby/object:Gem::Version
189
+ version: '0'
190
+ - !ruby/object:Gem::Dependency
191
+ name: yard
192
+ requirement: !ruby/object:Gem::Requirement
193
+ none: false
194
+ requirements:
195
+ - - ! '>='
196
+ - !ruby/object:Gem::Version
197
+ version: '0'
198
+ type: :development
199
+ prerelease: false
200
+ version_requirements: !ruby/object:Gem::Requirement
201
+ none: false
202
+ requirements:
203
+ - - ! '>='
204
+ - !ruby/object:Gem::Version
205
+ version: '0'
206
+ - !ruby/object:Gem::Dependency
207
+ name: markdown
208
+ requirement: !ruby/object:Gem::Requirement
209
+ none: false
210
+ requirements:
211
+ - - ! '>='
212
+ - !ruby/object:Gem::Version
213
+ version: '0'
214
+ type: :development
215
+ prerelease: false
216
+ version_requirements: !ruby/object:Gem::Requirement
217
+ none: false
218
+ requirements:
219
+ - - ! '>='
220
+ - !ruby/object:Gem::Version
221
+ version: '0'
222
+ description: Simple wrapper for the ESPN v1 API.
223
+ email:
224
+ - andrewpthorp@gmail.com
225
+ executables: []
226
+ extensions: []
227
+ extra_rdoc_files: []
228
+ files:
229
+ - .gitignore
230
+ - Gemfile
231
+ - Gemfile.lock
232
+ - README.md
233
+ - espn.gemspec
234
+ - lib/espn.rb
235
+ - lib/espn/client.rb
236
+ - lib/espn/client/sports.rb
237
+ - lib/espn/client/teams.rb
238
+ - lib/espn/configuration.rb
239
+ - lib/espn/connection.rb
240
+ - lib/espn/error.rb
241
+ - lib/espn/request.rb
242
+ - lib/espn/version.rb
243
+ - lib/faraday/response/raise_espn_error.rb
244
+ homepage: http://github.com/andrewpthorp/espn
245
+ licenses: []
246
+ post_install_message:
247
+ rdoc_options: []
248
+ require_paths:
249
+ - lib
250
+ required_ruby_version: !ruby/object:Gem::Requirement
251
+ none: false
252
+ requirements:
253
+ - - ! '>='
254
+ - !ruby/object:Gem::Version
255
+ version: '0'
256
+ required_rubygems_version: !ruby/object:Gem::Requirement
257
+ none: false
258
+ requirements:
259
+ - - ! '>='
260
+ - !ruby/object:Gem::Version
261
+ version: '0'
262
+ requirements: []
263
+ rubyforge_project:
264
+ rubygems_version: 1.8.23
265
+ signing_key:
266
+ specification_version: 3
267
+ summary: Simple wrapper for the ESPN v1 API.
268
+ test_files: []
269
+ has_rdoc: