dbc-ruby 1.0.0 → 1.0.1

data/README.md

@@ -1,18 +1,60 @@
-#DBC Ruby
+#DBC API Ruby Client
 
 ## Installation
 
 If you want to use the Dev Bootcamp (DBC) Ruby gem, run:
 
-	gem install --source https://someurl
-	
-## Requirements
+	gem install dbc-ruby
 
-* Ruby 1.9.3
-* rest-client
+## Configuration
 
-## Development
+You must have an api key to make api requests with this gem.
+You can see your api key by logging in at [dev.devbootcamp.com](http://dev.devbootcamp.com)
 
-Run unit test with: 
+Set your DBC_API environment variable to your api key, or use the gem to configure your key:
+```ruby
+DBC::token = # your api key
+```
+For making requests between DBC shared applications, you must also congifure the shared key.
+Set your DBC_SHARED environment variable to the shared key, or use the gem:
+```ruby
+DBC::shared_token = # the shared token
+```
 
-	bundle exec rake test
+## Methods
+
+### User
+
+Class methods:
+
+```ruby
+DBC::User.all() # => all users
+DBC::User.all(page: 1, per_page: 10) # => first 10 users
+DBC::User.find(id) # => a specific user by user_id
+```
+
+Instance methods:
+
+```ruby
+user.cohort # => a specific user's cohort object
+user.challenge_attempts # => a user's challenge attempts
+user.exercise_attempts # => a user's exercies attempts
+```
+
+### Cohort
+
+Class methods:
+
+```ruby
+DBC::Cohort.all() # => all cohorts
+DBC::Cohort.all(page: 1, per_page: 10) # => first 10 cohorts
+DBC::Cohort.find(id) # => a specific cohort by user_id
+```
+
+### Challenge
+
+### ChallengeAttempt
+
+### Exercise
+
+### ExerciseAttempt

data/lib/dbc-ruby/version.rb

@@ -1,3 +1,3 @@
 module DBC
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/dbc-ruby.rb

@@ -1,4 +1,4 @@
-require_relative 'dbc/dbc_object'
+  require_relative 'dbc/dbc_object'
 require_relative 'dbc/user'
 require_relative 'dbc/cohort'
 require_relative 'dbc/challenge'
@@ -11,7 +11,7 @@ require 'json'
 require 'rest_client'
 
 module DBC
-  @api_url = 'https://api.devbootcamp.com'
+  @api_url = 'https://api.devbootcamp.com/v1'
   @token = nil
   @shared_token = nil
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbc-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors: