teachable-stats 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 578241224c44c9e3e01e17badc09053f9c5f8fc7
-  data.tar.gz: cbcb16f4c2d68132c5391fd9c71082ea59ca737c
+  metadata.gz: a3b55698b6091bd707a99a8976b5164b7595248b
+  data.tar.gz: a7d40aded414bda94d5000f21cf84e257a26fea8
 SHA512:
-  metadata.gz: 9ffa51e559741b39bbdc20547c16556f41f626d291d9c0a3c5c52704b549db8873c3f013d3fd3e480eaaf184d0d6f58b9ad551dc960579b5c03f1cf829ad6184
-  data.tar.gz: a1b90057a89c02de11be38ff5e3409cc725a9e0b788748872e9a3dc16904758b0abc5c4b6d08538dfb661787c57dba5376fef6cb7fea9d9b6b741c87da6c9338
+  metadata.gz: edda8af6eda05f91cbe56257d3c1ff70f6656cbef1b7cb106d769a8d0806d41a84c3e64f53ef62670fb96a45722aec5a4baee7fbe801811c6212f22689487521
+  data.tar.gz: 39bd256bd10b145fc31902f652dd5f8d71b318b1f7e9b1e2a372e6c6d03abc63aba3b18d888b8d3e183462dcb3fe6a9ca5abc3d45b7b43dbd54ba55b7811c98f

data/README.md

@@ -24,7 +24,14 @@ Or install it yourself as:
 
 ## Usage
 
+On a high-level, this is how we will use the API:  
+
+1. Register for the API  
+2. Authenticate/Configure the gem for API use.
+3. Make API calls using the #get_user, #get_orders, #create_my_order, #destroy_my_order methods.  
+
 **Registering to the API**
+
 In order to use the gem, you first need to register an account with Teachable. You used to have to make a complicated post request directly to Teachable's API via this complicated curl request:
 
 ```bash
@@ -40,6 +47,7 @@ Teachable::Stats.register(email: "new_email@example.com", password: "8LettersLon
 Note the password field has to be at least 8 letters long and the email address cannot already exist in the database.
 
 **Getting user_token and credentials**
+
 If you are an already registered user and simply want your credentials sent back to you, you can simply get your credentials via this .get_token convenience method
 
 ```ruby
@@ -62,32 +70,33 @@ That will return your credentials, including your token, in this form:
 Note the returned value of the .get_token method is a ruby hash and it does not show your password. However, it does have your user_token which you need to use to configure your gem.
 
 **Configuring your gem**
+
 You need to set your :user_email and :user_token prior to making API requests to the Teachable API. Configuring your gem simply means providing the gem your registered user email and user_token. There are two ways to do this:
 
 1. In your application, you can write this code to manually configure your gem:
 
-```ruby
-Teachable::Stats.configuration do |config|
-  config.user_email = "your_email@example.com"
-  config.user_token = "some_secure_random_string_goes_here_that_you_can_get_via_the_get_token_method"
-end
-```
+  ```ruby
+  Teachable::Stats.configuration do |config|
+    config.user_email = "your_email@example.com"
+    config.user_token = "some_secure_random_string_goes_here_that_you_can_get_via_the_get_token_method"
+  end
+  ```
 
-Again, the user_email and user_token can be obtained via the .get_token method provided by the gem.
+  Again, the user_email and user_token can be obtained via the .get_token method provided by the gem.
 
-2. You can also configure your gem using the gem's .authenticate convenience method. This is how you can use the convenience method.
+2. Instead of calling .get_token and manually configuring the gem within your application, you can also configure your gem using the gem's .authenticate convenience method. This is how you can use the convenience method.
 
-```ruby
-Teachable::Stats.authenticate(email: "valid_email1@example.com", password: "password")
-```
+  ```ruby
+  Teachable::Stats.authenticate(email: "valid_email1@example.com", password: "password")
+  ```
 
-Give that above method a try! That email and password are valid. You should see something like this return:
+  Give that above method a try! That email and password are valid. You should see something like this return:
 
-```
-"Logged in as user: valid_email1@example.com with token: -y9s9TyMHdWmniBLfE8i"
-```
+  ```
+  "Logged in as user: valid_email1@example.com with token: -y9s9TyMHdWmniBLfE8i"
+  ```
 
-Behind the scenes, that sets the class variables called user_email and user_token to the email and user_token that are shown in the string. All you need to provide to the authenticate convenience method are your already registered and valid email and password. That's it!
+  (This doesn't actually truly authenticate with the API... it really just sets the class variables user_email and user_token so that they can be sent along with the API requests in query parameters.) Behind the scenes, that sets the class variables called user_email and user_token to the email and user_token that are shown in the string. All you need to provide to the authenticate convenience method are your already registered and valid email and password. That's it!
 
 ## Making queries to the Teachable API
 
@@ -105,12 +114,12 @@ Let's see how to make requests to all 4!
 Teachable::Stats.get_user
 ```
 
-**Orders*get**
+**Orders#get**
 ```ruby
 Teachable::Stats.get_orders
 ```
 
-**Orders*post**
+**Orders#post**
 ```ruby
 Teachable::Stats.create_my_order(number: 1, total: 2.0, total_quantity: 3, email: "valid_email1@example.com")
 ```
@@ -119,6 +128,7 @@ In the above convenience method for creating_orders, you currently need to provi
 
 The above method will create an order for the authenticated user. See this:
 
+**Orders#destroy**
 ```ruby
 Teachable::Stats.destroy_my_order(order_id: 2)
 ```
@@ -280,7 +290,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/teachable-stats.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Jwan622/teachable_challenge_gem
 
 Many thanks to the development team:
 - Jeffrey Wan

data/lib/helpers/configuration.rb

@@ -1,4 +1,3 @@
-
 module Configuration
   def configuration
     yield self

data/lib/helpers/custom_errors.rb

@@ -0,0 +1,13 @@
+module CustomErrors
+  class AuthenticationError < StandardError
+    def initialize(msg="You need to call #authenticate first and pass in your email and password. For example: Teachable::Stats.authenticate(email: 'YourEmail@example.com', password: 'password')")
+      super
+    end
+  end
+
+  class RegistrationError < StandardError
+    def initialize(msg="That username and password combination is incorrect. I think you need to register first.")
+      super
+    end
+  end
+end

data/lib/teachable/stats/version.rb

@@ -1,5 +1,5 @@
 module Teachable
   module Stats
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/teachable-stats.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{This is a wrapper for the mock Teachable API}
   spec.description   = %q{The teachable-stats gem is a wrapper for the Teachable API. Hopefully this saves you time!}
-  spec.homepage      = "https://github.com/Jwan622/teachable_challenge_gem/blob/master/lib/teachable/stats.rb"
+  spec.homepage      = "https://github.com/Jwan622/teachable_challenge_gem"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teachable-stats
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeffrey Wan
@@ -139,6 +139,7 @@ files:
 - bin/console
 - bin/setup
 - lib/helpers/configuration.rb
+- lib/helpers/custom_errors.rb
 - lib/teachable/stats.rb
 - lib/teachable/stats/authenticate.rb
 - lib/teachable/stats/get_token.rb
@@ -150,7 +151,7 @@ files:
 - lib/teachable/stats/version.rb
 - notes.md
 - teachable-stats.gemspec
-homepage: https://github.com/Jwan622/teachable_challenge_gem/blob/master/lib/teachable/stats.rb
+homepage: https://github.com/Jwan622/teachable_challenge_gem
 licenses: []
 metadata: {}
 post_install_message: 
@@ -174,3 +175,4 @@ signing_key:
 specification_version: 4
 summary: This is a wrapper for the mock Teachable API
 test_files: []
+has_rdoc: