dbc-ruby 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :development, :test do
+  gem 'rspec-rails'
+end
+
+
+group :test do
+  gem 'database_cleaner'
+end

data/README.md

@@ -0,0 +1,18 @@
+#DBC Ruby
+
+## Installation
+
+If you want to use the Dev Bootcamp (DBC) Ruby gem, run:
+
+	gem install --source https://someurl
+	
+## Requirements
+
+* Ruby 1.9.3
+* rest-client
+
+## Development
+
+Run unit test with: 
+
+	bundle exec rake test

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/dbc-ruby.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'dbc-ruby/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kevin Buchanan"]
+  gem.email         = ["kevaustinbuch@gmail.com"]
+  gem.description   = %q{REST API client for http://api.devbootcamp.com}
+  gem.summary       = %q{REST API client for http://api.devbootcamp.com}
+  gem.homepage      = "https://github.com/socrates-api/dbc-ruby"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "dbc-ruby"
+  gem.require_paths = ["lib"]
+  gem.version       = DBC::VERSION
+
+  gem.add_dependency 'rest-client'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'webmock'
+end

data/lib/dbc/api_key.rb

@@ -0,0 +1,12 @@
+module DBC
+	class ApiKey < DbcObject
+		def self.endpoint(id)
+			"/api_keys/" + id.to_s
+		end
+
+    def self.find(id)
+      api_response = DBC.request(self.endpoint(id))
+      self.create_dbc_object(api_response)
+    end
+	end
+end

data/lib/dbc/challenge.rb

@@ -0,0 +1,7 @@
+module DBC
+  class Challenge < DbcObject
+    def self.endpoint(id = '')
+      "/challenges/" + id.to_s
+    end
+  end
+end

data/lib/dbc/challenge_attempt.rb

@@ -0,0 +1,21 @@
+module DBC
+	class ChallengeAttempt < DbcObject
+    def self.endpoint(user_id, id = '')
+      "/users/#{user_id}/challenge_attempts/" + id
+    end
+
+    def self.find(user_id, id)
+      api_response = DBC.request(endpoint(user_id, id))
+      self.create_dbc_object(api_response)
+    end
+
+    def self.all(user_id, options = {})
+      api_response = DBC.request(endpoint(user_id), options)
+      self.create_dbc_objects(api_response)
+    end
+
+    def challenge
+      Challenge.find(@challenge_id)
+    end
+	end
+end

data/lib/dbc/cohort.rb

@@ -0,0 +1,12 @@
+module DBC
+  class Cohort < DbcObject
+    def initialize(attributes)
+      super
+      @students.map! { |user| DBC::User.new(user) }
+    end
+
+    def self.endpoint(id = '')
+      "/cohorts/" + id.to_s
+    end
+  end
+end

data/lib/dbc/dbc_object.rb

@@ -0,0 +1,36 @@
+module DBC
+  class DbcObject
+    def initialize(attributes)
+      attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def self.endpoint(id = '')
+      '/' + id.to_s
+    end
+
+    def self.all(options = {})
+      api_response = DBC.request(self.endpoint, options)
+      self.create_dbc_objects(api_response)
+    end
+
+    def self.find(id)
+      api_response = DBC.request(self.endpoint(id))
+      self.create_dbc_object(api_response)
+    end
+
+    private
+
+    def self.create_dbc_objects(api_response)
+      api_response.values.first.map! do |object|
+        self.new(object)
+      end
+      api_response
+    end
+
+    def self.create_dbc_object(api_response)
+      { api_response.keys.first => self.new(api_response.values.first) }
+    end
+  end
+end

data/lib/dbc/exercise.rb

@@ -0,0 +1,7 @@
+module DBC
+  class Exercise < DbcObject
+    def self.endpoint(id = '')
+      "/exercises/" + id.to_s
+    end
+  end
+end

data/lib/dbc/exercise_attempt.rb

@@ -0,0 +1,21 @@
+module DBC
+	class ExerciseAttempt < DbcObject
+		def self.endpoint(user_id, id = '')
+			"/users/#{user_id}/exercise_attempts/" + id
+		end
+
+		def self.find(user_id, id)
+			api_response = DBC.request(endpoint(user_id, id))
+			self.create_dbc_object(api_response)
+		end
+
+		def self.all(user_id, options = {})
+			api_response = DBC.request(endpoint(user_id), options)
+			self.create_dbc_objects(api_response)
+		end
+
+		def exercise
+			Exercise.find(@exercise_id)
+		end
+	end
+end

data/lib/dbc/user.rb

@@ -0,0 +1,19 @@
+module DBC
+  class User < DbcObject
+    def self.endpoint(id = '')
+      "/users/" + id.to_s
+    end
+
+    def challenge_attempts
+      ChallengeAttempt.all(@id)
+    end
+
+    def exercise_attempts
+      ExerciseAttempt.all(@id)
+    end
+
+    def cohort
+      Cohort.find(@cohort_id)
+    end
+  end
+end

data/lib/dbc-ruby/version.rb

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

data/lib/dbc-ruby.rb

@@ -0,0 +1,50 @@
+require_relative 'dbc/dbc_object'
+require_relative 'dbc/user'
+require_relative 'dbc/cohort'
+require_relative 'dbc/challenge'
+require_relative 'dbc/exercise'
+require_relative 'dbc/api_key'
+require_relative 'dbc/challenge_attempt'
+require_relative 'dbc/exercise_attempt'
+
+require 'json'
+require 'rest_client'
+
+module DBC
+  @api_url = 'https://api.devbootcamp.com'
+  @token = nil
+  @shared_token = nil
+
+  def self.token=(token)
+    @token = token
+  end
+
+  def self.token
+    @token ||= ENV['DBC_API']
+  end
+
+  def self.shared_token=(token)
+    @shared_token = token
+  end
+
+  def self.shared_token
+    @shared_token ||= ENV['DBC_SHARED']
+  end
+
+  def self.endpoint
+    @api_url
+  end
+
+  def self.request(path, options = {})
+    raise ArgumentError.new "You must set ENV['DBC_API'] to your api token" unless self.token
+    response = RestClient.get(@api_url + path, {accept: :json, authorization: 'DBC-API' + ' ' + @token, params: options})
+    JSON.parse(response.body, symbolize_names: true)
+  end
+
+  def self.request_with_shared_token(path, options = {})
+    raise ArgumentError.new "You must set ENV['DBC_SHARED'] to your shared token" unless self.shared_token
+    response = RestClient.get(@api_url + path, {accept: :json, authorization: 'DBC-SHARED' + ' ' + @shared_token , params: options})
+    JSON.parse(response.body, symbolize_names: true)
+  end
+end
+

data/spec/lib/dbc/dbc_object_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe DBC::DbcObject do
+  describe '.all' do
+    before do
+      ENV.stub(:[]).with('DBC_API').and_return('test123')
+      DBC.stub(:request).and_return({objects: [{attribute: 'test'}]})
+    end
+
+    it 'should make a request with the correct endpoint' do
+      expect(DBC).to receive(:request).with('/', {})
+      DBC::DbcObject.all()
+    end
+
+    it 'should return an array of objects' do
+      objects = DBC::DbcObject.all()[:objects]
+      expect(objects).to be_a(Array)
+      expect(objects.first).to be_a(DBC::DbcObject)
+    end
+  end
+
+  describe '.find' do
+    before do
+      ENV.stub(:[]).with('DBC_API').and_return('test123')
+      DBC.stub(:request).and_return({object: {attribute: 'test'}})
+    end
+
+    it 'should make a request with the correct endpoint' do
+      expect(DBC).to receive(:request).with('/1')
+      DBC::DbcObject.find(1)
+    end
+
+    it 'should return one object' do
+      expect(DBC::DbcObject.find(1)[:object]).to be_a(DBC::DbcObject)
+    end
+  end
+end

data/spec/lib/dbc-ruby_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe DBC do
+  describe '.request' do
+    context 'with an api token' do
+      before do
+        ENV.stub(:[]).with('DBC_API').and_return('test123')
+      end
+
+      it 'should make an api request' do
+        stub_request(:get, DBC.endpoint).to_return(body: JSON.generate({test: 'test'}))
+        expect{ DBC.request('') }.to_not raise_error
+      end
+    end
+
+    context 'without an api token' do
+      it 'should throw an argument error' do
+        expect{ DBC.request() }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '.request_with_shared_token' do
+    context 'with a shared token' do
+      before do
+        ENV.stub(:[]).with('DBC_SHARED').and_return('test123')
+      end
+
+      it 'should make an api request' do
+        stub_request(:get, DBC.endpoint).to_return(body: JSON.generate({test: 'test'}))
+        expect{ DBC.request_with_shared_token('') }.to_not raise_error
+      end
+    end
+
+    context 'without a shared token' do
+      it 'should throw an argument error' do
+        expect{ DBC.request_with_shared_token() }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'webmock/rspec'
+require 'dbc-ruby'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: dbc-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Buchanan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: REST API client for http://api.devbootcamp.com
+email:
+- kevaustinbuch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- dbc-ruby.gemspec
+- lib/dbc-ruby.rb
+- lib/dbc-ruby/version.rb
+- lib/dbc/api_key.rb
+- lib/dbc/challenge.rb
+- lib/dbc/challenge_attempt.rb
+- lib/dbc/cohort.rb
+- lib/dbc/dbc_object.rb
+- lib/dbc/exercise.rb
+- lib/dbc/exercise_attempt.rb
+- lib/dbc/user.rb
+- spec/lib/dbc-ruby_spec.rb
+- spec/lib/dbc/dbc_object_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/socrates-api/dbc-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: REST API client for http://api.devbootcamp.com
+test_files:
+- spec/lib/dbc-ruby_spec.rb
+- spec/lib/dbc/dbc_object_spec.rb
+- spec/spec_helper.rb