thinkific_ruby_test 0.1.0

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,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 8f7c8cec8b5906559048f545ca42824c1256e1fb
4
+ data.tar.gz: d205fda8c1c02130fec9272e98b75925ed230917
5
+ SHA512:
6
+ metadata.gz: 92fa596c418fe5d5fb58c3419bd7ba562111387b20a438b16900996f0d3e5aefab75e50995fec2c872a60e9c115905609a419fc63b18e2e6b24edf8ad8e946d4
7
+ data.tar.gz: 86fba3641353b8360bd01480b8ea27b9ba2cc70203d3fec589a0f493d128be98fcbb548ca00241dac5c1c8266815fab6208a9181b62db4a68cfd43e8925451ee
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in thinkific_ruby.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 daniel-johnson
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.
@@ -0,0 +1,41 @@
1
+ # ThinkificRuby
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/thinkific_ruby`. 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 'thinkific_ruby'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install thinkific_ruby
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 test` 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]/thinkific_ruby.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "thinkific_ruby"
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
@@ -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,32 @@
1
+ require "thinkific_ruby/version"
2
+ require "faraday"
3
+ require "json"
4
+ require "pry-byebug"
5
+
6
+ require "thinkific_ruby/api_error.rb"
7
+ require "thinkific_ruby/configuration_error.rb"
8
+ require "thinkific_ruby/input_error.rb"
9
+
10
+ require "thinkific_ruby/connection.rb"
11
+ require "thinkific_ruby/resource_helper.rb"
12
+ require "thinkific_ruby/course_review.rb"
13
+
14
+ module ThinkificRuby
15
+ class << self
16
+ attr_accessor :configuration
17
+
18
+ def configure
19
+ self.configuration ||= Configuration.new
20
+ yield(configuration)
21
+ end
22
+ end
23
+
24
+ class Configuration
25
+ attr_accessor :api_key, :subdomain
26
+
27
+ def initialize
28
+ @api_key = nil
29
+ @subdomain = nil
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,16 @@
1
+ module ThinkificRuby
2
+ class ApiError < StandardError
3
+ attr_reader :status_code
4
+ attr_reader :response
5
+
6
+ DEFAULT_MSG = "There was an error with your API request. Check the status code and response_body for details."
7
+
8
+ # we'll still give it an optional error message, but leave it as the default which will tell them to check the status and body in the error object
9
+ def initialize(status_code, response, msg=DEFAULT_MSG)
10
+ @status_code = status_code
11
+ @response = response
12
+
13
+ super(msg)
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,8 @@
1
+ module ThinkificRuby
2
+ class ConfigurationError < StandardError
3
+
4
+ def initialize(msg="You're Thinkific Ruby configuration is not setup. Please see the readme for instructions.")
5
+ super
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,16 @@
1
+ module ThinkificRuby
2
+ module Connection
3
+
4
+ protected
5
+
6
+ def connection
7
+ begin
8
+ Faraday.new(url: "https://api.thinkific.com",
9
+ headers: {'X-Auth-API-Key' => ThinkificRuby.configuration.api_key,
10
+ 'X-Auth-Subdomain' => ThinkificRuby.configuration.subdomain })
11
+ rescue NoMethodError
12
+ raise ThinkificRuby::ConfigurationError
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,40 @@
1
+ module ThinkificRuby
2
+ class CourseReview
3
+
4
+ extend ThinkificRuby::Connection
5
+ extend ThinkificRuby::ResourceHelper
6
+
7
+ class << self
8
+ def index(course_id, options = {})
9
+ raise_input_error_if_not_natural_number(course_id)
10
+
11
+ response = connection.get('/api/public/v1/course_reviews') do |req|
12
+ req.params['course_id'] = course_id
13
+
14
+ options.each {|key, value| req.params[key.to_s] = value }
15
+ end
16
+
17
+ parsed_response = JSON.parse(response.body)
18
+
19
+ raise_error_if_response_status_not_200_or_return_parsed_response(response.status, parsed_response)
20
+ end
21
+
22
+ def show(id)
23
+ raise_input_error_if_not_natural_number(id)
24
+
25
+ response = connection.get("/api/public/v1/course_reviews/#{ id }")
26
+
27
+ JSON.parse(response.body)
28
+ end
29
+
30
+ def create(options = {})
31
+
32
+ response = connection.post('/api/public/v1/course_reviews') do |req|
33
+ options.each {|key, value| req.params[key.to_s] = value }
34
+ end
35
+
36
+ JSON.parse(response.body)
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,8 @@
1
+ module ThinkificRuby
2
+ class InputError < StandardError
3
+
4
+ def initialize(msg="Invalid input.")
5
+ super
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,21 @@
1
+ require_relative './input_error.rb'
2
+ require_relative './api_error.rb'
3
+
4
+ module ThinkificRuby
5
+ module ResourceHelper
6
+
7
+ def raise_input_error_if_not_natural_number(id)
8
+
9
+ if id <= 0
10
+ raise ThinkificRuby::InputError
11
+ end
12
+ end
13
+
14
+ def raise_error_if_response_status_not_200_or_return_parsed_response(response_status, parsed_response_body)
15
+ unless response_status == 200
16
+ raise ThinkificRuby::ApiError.new(response_status, parsed_response_body)
17
+ end
18
+ parsed_response_body
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,5 @@
1
+ module ThinkificRuby
2
+ module TestConnection
3
+
4
+ end
5
+ end
@@ -0,0 +1,3 @@
1
+ module ThinkificRuby
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,45 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'thinkific_ruby/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "thinkific_ruby_test"
8
+ spec.version = ThinkificRuby::VERSION
9
+ spec.authors = ["daniel-johnson"]
10
+ spec.email = ["janiel.dohnson@gmail.com"]
11
+
12
+ spec.summary = %q{A Thinkific API ruby wrapper}
13
+ spec.description = %q{A fantastic ruby gem for interacting with the Thinkific API. But I'm just testing it right now, so please ignore.}
14
+ spec.homepage = "https://github.com/daniel-johnson/thinkific_ruby"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ # if spec.respond_to?(:metadata)
20
+ # spec.metadata['allowed_push_host'] = "http://RubyGems.org"
21
+ # else
22
+ # raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ # end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.12"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ spec.add_development_dependency "minitest", "~> 5.0"
33
+ spec.add_development_dependency 'webmock', '~> 2.0', '>= 2.0.3'
34
+ spec.add_development_dependency "pry-byebug", "~> 3.4"
35
+ spec.add_dependency "faraday", "~> 0.9.2"
36
+ spec.add_dependency "json", '~> 1.8', '>= 1.8.3'
37
+ end
38
+
39
+ # ▄▄▄▄▄ ██ ▄ ▄█ ▄███▄ █ ▄ ▄ ██ ▄▄▄▄▄ ▄ █ ▄███▄ █▄▄▄▄ ▄███▄
40
+ # ▄▀ █ █ █ █ ██ █▀ ▀ █ █ █ █ █ █ ▀▄ █ █ █▀ ▀ █ ▄▀ █▀ ▀
41
+ # █ █▄▄█ ██ █ ██ ██▄▄ █ █ ▄ █ █▄▄█ ▄ ▀▀▀▀▄ ██▀▀█ ██▄▄ █▀▀▌ ██▄▄
42
+ # ▄ █ █ █ █ █ █ ▐█ █▄ ▄▀ ███▄ █ █ █ █ █ ▀▄▄▄▄▀ █ █ █▄ ▄▀ █ █ █▄ ▄▀
43
+ # ▀ █ █ █ █ ▐ ▀███▀ ▀ █ █ █ █ █ ▀███▀ █ ▀███▀
44
+ # █ █ ██ ▀ ▀ █ ▀ ▀
45
+ # ▀ ▀
metadata ADDED
@@ -0,0 +1,173 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: thinkific_ruby_test
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - daniel-johnson
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-17 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.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
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: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: webmock
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '2.0'
62
+ - - ">="
63
+ - !ruby/object:Gem::Version
64
+ version: 2.0.3
65
+ type: :development
66
+ prerelease: false
67
+ version_requirements: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - "~>"
70
+ - !ruby/object:Gem::Version
71
+ version: '2.0'
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: 2.0.3
75
+ - !ruby/object:Gem::Dependency
76
+ name: pry-byebug
77
+ requirement: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: '3.4'
82
+ type: :development
83
+ prerelease: false
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - "~>"
87
+ - !ruby/object:Gem::Version
88
+ version: '3.4'
89
+ - !ruby/object:Gem::Dependency
90
+ name: faraday
91
+ requirement: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - "~>"
94
+ - !ruby/object:Gem::Version
95
+ version: 0.9.2
96
+ type: :runtime
97
+ prerelease: false
98
+ version_requirements: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - "~>"
101
+ - !ruby/object:Gem::Version
102
+ version: 0.9.2
103
+ - !ruby/object:Gem::Dependency
104
+ name: json
105
+ requirement: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - "~>"
108
+ - !ruby/object:Gem::Version
109
+ version: '1.8'
110
+ - - ">="
111
+ - !ruby/object:Gem::Version
112
+ version: 1.8.3
113
+ type: :runtime
114
+ prerelease: false
115
+ version_requirements: !ruby/object:Gem::Requirement
116
+ requirements:
117
+ - - "~>"
118
+ - !ruby/object:Gem::Version
119
+ version: '1.8'
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: 1.8.3
123
+ description: A fantastic ruby gem for interacting with the Thinkific API. But I'm
124
+ just testing it right now, so please ignore.
125
+ email:
126
+ - janiel.dohnson@gmail.com
127
+ executables: []
128
+ extensions: []
129
+ extra_rdoc_files: []
130
+ files:
131
+ - ".gitignore"
132
+ - ".travis.yml"
133
+ - Gemfile
134
+ - LICENSE.txt
135
+ - README.md
136
+ - Rakefile
137
+ - bin/console
138
+ - bin/setup
139
+ - lib/thinkific_ruby.rb
140
+ - lib/thinkific_ruby/api_error.rb
141
+ - lib/thinkific_ruby/configuration_error.rb
142
+ - lib/thinkific_ruby/connection.rb
143
+ - lib/thinkific_ruby/course_review.rb
144
+ - lib/thinkific_ruby/input_error.rb
145
+ - lib/thinkific_ruby/resource_helper.rb
146
+ - lib/thinkific_ruby/test_connection.rb
147
+ - lib/thinkific_ruby/version.rb
148
+ - thinkific_ruby.gemspec
149
+ homepage: https://github.com/daniel-johnson/thinkific_ruby
150
+ licenses:
151
+ - MIT
152
+ metadata: {}
153
+ post_install_message:
154
+ rdoc_options: []
155
+ require_paths:
156
+ - lib
157
+ required_ruby_version: !ruby/object:Gem::Requirement
158
+ requirements:
159
+ - - ">="
160
+ - !ruby/object:Gem::Version
161
+ version: '0'
162
+ required_rubygems_version: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ requirements: []
168
+ rubyforge_project:
169
+ rubygems_version: 2.5.1
170
+ signing_key:
171
+ specification_version: 4
172
+ summary: A Thinkific API ruby wrapper
173
+ test_files: []