rubykhan 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bec0c1ae5ebd2ab2537e2ac37a78fae1a2d870ae
-  data.tar.gz: 70cd2fd9c6def184c726b1f11a9781249f53bdc6
+  metadata.gz: 518cf524ff5f5807da8cb0f146a0ce86471dea84
+  data.tar.gz: 407637a0963e13bddf9c125258be95267eca8557
 SHA512:
-  metadata.gz: f71cbde9f612a12db1541e76981c5c93f10dfde14560c53726dfbbcf0a498354e9f74d8fb34e9f01809ea8ed9417047d46eda066eeaf62fee6b2ef06179546c2
-  data.tar.gz: 2105c4b6096180e6a70d55e853a7f6a8dbe2515fb3b6b7465bd1d50bd93645be4c9c41b7eeefd4e7919258b761f2fa8f637132cda85af575184a6188e3e39af5
+  metadata.gz: c290d5454784dcb2dcbf03d5761b2c8397c520a3d76a3143908258caccc075f205c8a9f2c0e05051581c7012107cd4d9eb6c5cd20c9b573e8705d220b4f3f6ed
+  data.tar.gz: 263dce5d464a64e1a0c9e19d7c0b68577916a7cc9974e0a5e93c718a089d6fef31cc0cb825bb06c47a3ac7d5cd0606b4a579a2f2bf6a461e95e24b9ee0859e9c

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - ruby-head

data/Gemfile

@@ -1,4 +1,21 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rubykhan.gemspec
-gemspec
+gem 'httparty'
+gem 'rake'
+
+group :development do
+	gem 'pry'
+	gem 'simplecov'
+	gem 'jeweler', '~> 1.8.7'
+	gem 'bundler', '~> 1.0'
+	gem 'rdoc', '~> 3.12'
+	gem 'shoulda', '>=0'
+end
+
+group :test do
+  gem 'webmock'
+  gem 'simplecov'
+  gem 'coveralls'
+  gem 'rspec'
+  gem 'shoulda-matchers'
+end

data/Gemfile.lock

@@ -0,0 +1,124 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    mime-types (2.0)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (0.9.7)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tins (0.12.0)
+    tzinfo (0.3.38)
+    webmock (1.15.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  coveralls
+  httparty
+  jeweler (~> 1.8.7)
+  pry
+  rake
+  rdoc (~> 3.12)
+  rspec
+  shoulda
+  shoulda-matchers
+  simplecov
+  webmock

data/LICENSE.txt

@@ -1,6 +1,6 @@
-Copyright (c) 2013 Dan Crews
-
 MIT License
+=======
+Copyright (c) 2013 Abby Howell and Dan Crews
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,26 +1,93 @@
-# Rubykhan
 
-TODO: Write a gem description
+# RubyKhan: a Khan Academy API gem
 
-## Installation
 
-Add this line to your application's Gemfile:
+[![Gem Version](https://badge.fury.io/rb/rubykhan.png)](http://badge.fury.io/rb/rubykhan)
 
-    gem 'rubykhan'
+[![Coverage Status](https://coveralls.io/repos/abigezunt/rubykhan/badge.png)](https://coveralls.io/r/abigezunt/rubykhan)
 
-And then execute:
+[![Build Status](https://travis-ci.org/abigezunt/rubykhan.png?branch=master)](https://travis-ci.org/abigezunt/rubykhan)
 
-    $ bundle
+[![Code Climate](https://codeclimate.com/github/abigezunt/rubykhan.png)](https://codeclimate.com/github/abigezunt/rubykhan)
 
-Or install it yourself as:
+```ruby
+gem 'rubykhan'
+```
 
-    $ gem install rubykhan
+```ruby
+require 'rubykhan'
+```
 
-## Usage
+## Accessing the Khan Academy API
 
-TODO: Write usage instructions here
+Information from Khan academy's API is accessed through topic keywords called "slugs" that you can use in your API requests.  Topics are arranged hierarchically from the most general (e.g. "math", "science", "humanities") to the very specific. 
 
-## Contributing
+To see the whole topic tree hash, you can instantiate a Topic Tree object:
+
+```ruby
+all = KhanAcademy::TopicTree.new
+```
+
+And you can inspect the whole hierarchy to see what is returned via json:
+
+```ruby
+all.topictree
+```
+
+You can also retrieve a hash of just the topic slugs to choose from for your further queries:
+
+```ruby
+all.topics
+```
+
+Another API query returns more detailed information about a topic, including its children, which can be other, more specific topics, or videos and exercises.  The most specific sub-sub-topics have videos and exercises, but the top-level topics don't, so you won't get any exercises for a topic like "math" or even something as specific as "algebra", but the topic "solving-linear-equations-and-inequalities does return some exercises.  It sometimes takes several queries to get to that level.
+
+To query about a topic, instantiate a topic object:
+
+```ruby
+getty_museum = KhanAcademy::Topic.new('getty-museum')
+```
+
+You can access the json response directly with the `.json` method:
+
+```ruby
+getty_museum.json
+```
+
+You can also access many attributes with ruby attribute accessor methods:
+
+```ruby
+description = getty_museum.description
+title = getty_museum.title
+url = getty_museum.url
+parent_topic = getty_museum.parent_topic
+```
+
+To see the list of related subtopics and videos:
+
+```ruby
+children = getty_museum.children
+```
+
+```ruby
+algebra = KhanAcademy::Topic.new('algebra')
+algebra.subtopics
+```
+
+```ruby
+linear_equations = KhanAcademy::Topic.new('solving-linear-equations-and-inequalities')
+linear_equations.subtopics
+```
+
+More information about the Khan Academy API can be found at the [Khan Academy API Explorer](http://api-explorer.khanacademy.org/api/v1/).
+
+## FAQ: 
+
+Q: What's up with the name?
+
+A: It's a pun on [Crossing the Rubicon](https://www.khanacademy.org/humanities/history/ancient-medieval/Ancient/v/a-tour-through-ancient-rome-in-320-c-e).  Julius Caesar would've used Ruby in his conquest of Gaul, and we want you to be able to use Ruby in your  Khan Academy app.  :)
+
+## CONTRIBUTING
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# Pulls in equiv of 'rspec spec' to be 'rake spec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# If you just run 'rake', it will run 'rake spec'
+task test: :spec
+task default: :spec

data/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/lib/rubykhan/version.rb

@@ -1,3 +1,3 @@
 module Rubykhan
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rubykhan.rb

@@ -1,22 +1,138 @@
-require 'rubykhan/client'
-
-module Rubykhan
-  class << self
-    # attr_accessor :key
-    def configure
-      yield self
-    end
-
-    def new
-    end
-
-    def method_missing(method, *args, &block)
-      return super unless new.respond_to?(method)
-      new.send(method, *args, &block)
-    end
-
-    def respond_to?(method, include_private=false)
-      new.respond_to?(method, include_private) || super(method, include_private)
-    end
-  end
+# require 'rubykhan/client'
+
+# module Rubykhan
+#   class << self
+#     # attr_accessor :key
+#     def configure
+#       yield self
+#     end
+
+#     def new
+#     end
+
+#     def method_missing(method, *args, &block)
+#       return super unless new.respond_to?(method)
+#       new.send(method, *args, &block)
+#     end
+
+#     def respond_to?(method, include_private=false)
+#       new.respond_to?(method, include_private) || super(method, include_private)
+#     end
+#   end
+# end
+require 'pry'
+require 'httparty'
+require 'json'
+
+module KhanAcademy
+
+
+	class TopicTree
+		attr_reader :topictree
+
+	  def initialize
+	  	@topictree = HTTParty.get('http://www.khanacademy.org/api/v1/topictree')
+	  end
+
+	  def topics
+	    @main_topics = @topictree['children'].map { |topic| topic['slug']}	
+	  	topics = {}
+	  	@main_topics.each_with_index do |topic, index|
+	      topics[topic] = @topictree['children'][index]['children'].map {|subtopic| subtopic['slug']}
+	    end
+	    return topics
+	  end
+
+	end
+
+
+	class Topic
+		attr_reader :json
+
+		def initialize(topic_slug)
+			@topic_slug = topic_slug
+			@json = HTTParty.get("http://www.KhanAcademy.org/api/v1/topic/#{@topic_slug}")
+		end
+
+		def title
+	  	@json['title']
+	  end
+
+	  def children
+	  	@json['children']
+	  end
+
+	  def kind
+	  	@json['kind']
+	  end
+
+	  def standalone_title
+	    @json['standalone_title']
+	  end
+
+		def description
+			@json['description']
+		end
+
+		def slug
+			@json['slug']
+		end
+
+		def node_slug
+			@json['node_slug']
+		end
+
+		def extended_slug
+			@json['extended_slug']
+		end
+
+		def facebook_url
+			@json['facebook_url']
+		end
+
+		def twitter_url
+			@json['twitter_url']
+		end
+
+		def web_url
+			@json['web_url']
+		end
+
+		def ka_url
+			@json['ka_url']
+		end
+
+		def url
+			@json['url'] || @json['ka_url'] || @json['web_url']
+		end
+
+		def topic_page_url
+		  @json['topic_page_url']
+		end
+
+		def subtopics_count
+			@json.children.count
+		end
+
+		def parent_topic
+			@json['domain_slug']
+		end
+
+		def icon_src
+			@json['icon_src']
+		end
+
+	  def subtopics
+	    @json['children'].map do |topic|
+	    	{title: topic['title'],
+	    	url: topic['url'],
+	      internal_id: topic['internal_id'],
+	      node_slug: topic['node_slug'],
+	      translated_title: topic['translated_title'],
+	      id: topic['id'],
+	      kind: topic['kind']}
+	    end
+	  end
+
+	end
 end

data/lib/topics.rb

@@ -0,0 +1,100 @@
+
+# 	class Topic
+# 		attr_reader :topic_slug, :data, :url, :id, :children, :slug, :kind, :tags, :url, :title, :node_slug, :subtopics
+# 		def initialize(topic_slug)
+# 			@topic_slug = topic_slug
+# 			@data = HTTParty.get("http://www.KhanAcademy.org/api/v1/topic/#{@topic_slug}")
+# 	    @ka_url = @data['ka_url']
+# 	    @id = @data['id']
+# 	    @children = @data['children']
+# 	    @slug = @data['slug']
+# 	    @kind = @data['kind']
+# 	    @tags = @data['tags']
+# 	    @url = @data['url']
+# 	    @title = @data['title']
+# 	    @node_slug = @data['node_slug']
+# 	    @internal_id = data['internal_id']
+# 	    @url = data['url']
+# 	    @node_slug = data['node_slug']
+# 	    @edit_slug = data['edit_slug']
+# 	    @key = data['key']
+# 	    @translated_title = data['translated_title']
+# 	    if data['children']
+# 		    @children = data['children']
+# 		    @subtopics = []
+# 		    @videos = []
+# 		    @exercises = []
+# 		    instantiate_subtopics
+# 	    end
+
+# 	  end
+
+# 	  private
+
+# 	  def instantiate_subtopics
+
+# 	  	@children.each do |child|
+# 	  		case child['kind'] 
+# 	  		when "Topic"
+#           begin
+#             @subtopics << KhanAcademy::Topic.new(child['id'])
+#           rescue
+#           	@subtopics << KhanAcademy::Subtopic.new(child)
+#           end
+# 	  		when "Video"
+# 	  			@videos << KhanAcademy::Video.new(child)
+# 	  		when "Exercise"
+# 	  			@exercises << KhanAcademy::Exercise.new(child)
+# 	  		end
+# 	  	end
+# 	  end
+# 	end
+
+# 	class Subtopic
+# 		attr_reader :data, :kind, :internal_id, :title, :url, :node_slug, :edit_slug, :key, :translated_title, :id
+# 		def initialize(data)
+# 			@data = data
+# 	    @kind = data['kind']
+# 	    @internal_id = data['internal_id']
+# 	    @title = data['title']
+# 	    @url = data['url']
+# 	    @node_slug = data['node_slug']
+# 	    @edit_slug = data['edit_slug']
+# 	    @key = data['key']
+# 	    @translated_title = data['translated_title']
+# 	    @id = data['id']
+# 	  end
+
+# 	end
+
+#   class Video
+#   	def initialize(data)
+#   		@kind = data['kind']
+#   		@internal_id = data['internal_id']
+#   		@title = data['title']
+#   		@url = data['url']
+#   		@node_slug = data['node_slug']
+#   		@edit_slug = data['edit_slug']
+#   		@key = data['key']
+#   		@translated_title = data['translated_title']
+#   		@id = data['id']
+#   	end
+#   end
+
+#   class Exercise
+#   	def initialize(data)
+#   		@kind = data['kind']
+#   		@internal_id = data['internal_id']
+#   		@title = data['title']
+#   		@url = data['url']
+#   		@node_slug = data['node_slug']
+#   		@edit_slug = data['edit_slug']
+#   		@key = data['key']
+#   		@translated_title = data['translated_title']
+#   		@id = data['id']
+#   	end
+#   end
+
+# end
+
+

data/rubykhan/.gitignore

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

data/rubykhan/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubykhan.gemspec
+gemspec

data/rubykhan/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Crews
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/rubykhan/README.md

@@ -0,0 +1,29 @@
+# Rubykhan
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubykhan'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubykhan
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/rubykhan/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/rubykhan/lib/rubykhan/version.rb

@@ -0,0 +1,3 @@
+module Rubykhan
+  VERSION = "0.0.1"
+end