lingq 0.1.1

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_WITHOUT: ""

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+source "http://gems.github.com/"
+
+gem "httparty"
+
+group(:test){
+  gem "test-unit"
+  gem "thoughtbot-shoulda"
+  gem "webmock"
+}

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ethan Vizitei
+
+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/README.rdoc

@@ -0,0 +1,37 @@
+= lingq
+
+Gem for interacting with the API of lingq.com.  It's a language learning website, and it's pretty useful, but I want to be able to work on my flashcards offline.  This gem is being written to be included in a desktop client (and maybe eventually a mobile client), but will certainly still be useful as a standalone api wrapper for other projects that want to interact with Lingq.com
+
+== Getting Started
+
+You need the API key for your account.  Usage is as follows:
+
+  require 'lingq'
+  client = Lingq::Client.new("apikey")
+  
+  #must be one of the languages available for this user, check client.languages array
+  client.change_language!("ru") 
+  
+  #load all lessons for the user
+  lessons = client.lessons 
+  
+  #load all lingq flashcards for the user
+  words = client.words
+
+== Current Status
+
+Right now just data pulling is done.  Will add soon the ability to update lingqs and load lingqs by lesson.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ethan Vizitei. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "lingq"
+    gem.summary = %Q{API Wrapper for Lingq.com}
+    gem.description = %Q{Gem for interacting with the API of lingq.com.  It's a language learning website, and it's pretty useful, but I want to be able to work on my flashcards offline.  This gem is being written to be included in a desktop client (and maybe eventually a mobile client), but will certainly still be useful as a standalone api wrapper for other projects that want to interact with Lingq.com}
+    gem.email = "ethan.vizitei@gmail.com"
+    gem.homepage = "http://github.com/evizitei/lingq"
+    gem.authors = ["Ethan Vizitei"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lingq #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/lingq.rb

@@ -0,0 +1,5 @@
+Bundler.setup(:default)
+
+require 'lingq/lesson'
+require 'lingq/word'
+require 'lingq/client'

data/lib/lingq/client.rb

@@ -0,0 +1,46 @@
+require 'httparty'
+
+module Lingq
+  class Client
+    include HTTParty
+    base_uri 'lingq.com/api_v2'
+    
+    attr_reader :target_language
+    attr_reader :languages
+    
+    def initialize(api_key)
+      @apikey = api_key
+      load_languages!
+    end
+    
+    def learning_language?(language_code)
+      @languages.index(language_code)
+    end
+    
+    def load_languages!
+      @languages = get_with_key('/languages/').parsed_response
+      @target_language = @languages.first
+    end
+    
+    def change_language!(language_code)
+      @target_language = language_code if learning_language?(language_code)
+    end
+    
+    def lessons
+      get_with_language("lessons/").map{|hash| Lingq::Lesson.new(@target_language,hash)}
+    end
+    
+    def words
+      get_with_language("lingqs/").map{|hash| Lingq::Word.new(@target_language,hash)}
+    end
+    
+  private
+    def get_with_key(path,params={})
+      self.class.get(path,{:query=>params.merge({:apikey=>@apikey})})
+    end
+    
+    def get_with_language(path,params={})
+      get_with_key("/#{@target_language}/#{path}",params)
+    end
+  end
+end

data/lib/lingq/lesson.rb

@@ -0,0 +1,13 @@
+module Lingq
+  class Lesson
+    attr_reader :audio_url,:image_url,:id,:cards_count,:title,:language
+    def initialize(language_code,json)
+      @language = language_code
+      @audio_url = json["audio_url"]
+      @image_url = json["image_url"]
+      @id = json["id"]
+      @cards_count = json["cards_count"]
+      @title = json["title"]
+    end
+  end
+end

data/lib/lingq/word.rb

@@ -0,0 +1,13 @@
+module Lingq
+  class Word
+    attr_reader :hint,:term,:id,:fragment,:status,:language
+    def initialize(language_code,json)
+      @language = language_code
+      @hint = json["hint"]
+      @term = json["term"]
+      @id = json["id"]
+      @fragment = json["fragment"]
+      @status = json["status"]
+    end
+  end
+end

data/lingq.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{lingq}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ethan Vizitei"]
+  s.date = %q{2010-06-19}
+  s.description = %q{Gem for interacting with the API of lingq.com.  It's a language learning website, and it's pretty useful, but I want to be able to work on my flashcards offline.  This gem is being written to be included in a desktop client (and maybe eventually a mobile client), but will certainly still be useful as a standalone api wrapper for other projects that want to interact with Lingq.com}
+  s.email = %q{ethan.vizitei@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".bundle/config",
+     ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/lingq.rb",
+     "lib/lingq/client.rb",
+     "lib/lingq/lesson.rb",
+     "lib/lingq/word.rb",
+     "lingq.gemspec",
+     "test/helper.rb",
+     "test/test_client.rb",
+     "test/test_lesson.rb",
+     "test/test_word.rb"
+  ]
+  s.homepage = %q{http://github.com/evizitei/lingq}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{API Wrapper for Lingq.com}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_client.rb",
+     "test/test_lesson.rb",
+     "test/test_word.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require "bundler"
+Bundler.setup(:default,:test)
+require 'test/unit'
+require 'shoulda'
+require 'webmock/test_unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lingq'
+
+class Test::Unit::TestCase
+  include WebMock
+end

data/test/test_client.rb

@@ -0,0 +1,76 @@
+require 'helper'
+
+class TestClient < Test::Unit::TestCase
+  context "" do
+    setup do
+      language_body = %Q{["ru","fr"]}
+      stub_api("languages",language_body)
+      @client = Lingq::Client.new("api-key")
+    end
+    
+    context "new client" do
+    
+      should "cache languages being learned at creation" do
+        assert_equal ["ru","fr"],@client.languages
+        assert @client.learning_language?("ru")
+        assert @client.learning_language?("fr")
+      end 
+    
+      should "exclude languages not being learned" do
+        assert !@client.learning_language?("en")
+      end
+    
+      should "pick first in list as current language" do
+        assert_equal "ru",@client.target_language
+      end
+    
+      should "be able to change to another valid language" do
+        @client.change_language!("fr")
+        assert_equal "fr",@client.target_language
+      end
+    
+    end
+  
+    context "prebuilt client for lesson call" do
+      setup do
+        body = %Q{[ { "audio_url": "http://m.lingq.com/media/_28/resources/contents/audio/2007/06/21/eating-out-3.mp3", "image_url": "http://m.lingq.com/media/_28/resources/contents/images/2008/08/26/Eating_Out_______.jpg", "id": 21730, "cards_count": 31, "title": "Part 3" }, 
+                    { "audio_url": "http://m.lingq.com/media/_28/resources/contents/audio/2007/06/21/eating-out-2.mp3", "image_url": "http://m.lingq.com/media/_28/resources/contents/images/2008/08/26/Eating_Out________.jpg", "id": 21729, "cards_count": 5, "title": "Part 2" }, 
+                    { "audio_url": "http://m.lingq.com/media/_28/resources/contents/audio/2007/06/21/eating-out-1.mp3", "image_url": "http://m.lingq.com/media/_28/resources/contents/images/2008/07/04/restaurant-120.jpg", "id": 21727, "cards_count": 19, "title": "Part 1" } ]}
+        stub_api("ru/lessons",body)
+        @lessons = @client.lessons
+      end
+    
+      should "load an array of lessons" do
+        assert_equal Lingq::Lesson,@lessons.first.class
+      end
+      
+      should "load one lesson for each json hash" do
+        assert_equal 3,@lessons.size
+      end
+    end
+    
+    context "prebuilt client for words call" do
+      setup do
+        body = %Q{[ { "status": 0, "fragment": "вперед и вы найдете его .", "term": "Его", "id": 4259928, "hint": "him" }, 
+          { "status": 0, "fragment": "Официант, принесите нам счет , пожалуйста", "term": "Счет", "id": 4259923, "hint": "check " }, 
+          { "status": 0, "fragment": "Легко сказать да трудно сделать.", "term": "трудно", "id": 4259919, "hint": "difficult" }, 
+          { "status": 0, "fragment": "Легко сказать да трудно сделать.", "term": "Легко", "id": 4259916, "hint": "easily" }, 
+          { "status": 0, "fragment": "стараться делать это с радостью .", "term": "радостью", "id": 4259915, "hint": "joy" }]}
+        stub_api("ru/lingqs",body)
+        @words = @client.words
+      end
+      
+      should "load an array of lessons" do
+        assert_equal Lingq::Word,@words.first.class
+      end
+      
+      should "load one lesson for each json hash" do
+        assert_equal 5,@words.size
+      end
+    end
+  end
+  
+  def stub_api(path,body)
+    stub_request(:any, "http://lingq.com/api_v2/#{path}/?apikey=api-key").to_return(:body => body, :status => 200,  :headers => { 'Content-Type' => "application/json; charset=utf-8" } )
+  end
+end

data/test/test_lesson.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class TestLesson < Test::Unit::TestCase
+  context "lesson" do
+    setup do
+      @lesson = Lingq::Lesson.new("ru",{"audio_url"=>"http://m.lingq.com/media/_28/resources/contents/audio/2007/06/21/eating-out-3.mp3", 
+                                   "image_url"=>"http://m.lingq.com/media/_28/resources/contents/images/2008/08/26/Eating_Out_______.jpg", 
+                                   "id"=> 21730, "cards_count"=> 31, "title"=> "Part 3" })
+    end
+    
+    should "cache audio url" do
+      assert @lesson.audio_url =~ /eating-out-3\.mp3/
+    end
+    
+    should "cache image url" do
+      assert @lesson.image_url =~ /Eating_Out_______\.jpg/
+    end
+    
+    should "cache id" do
+      assert_equal 21730,@lesson.id
+    end
+    
+    should "cache card count" do
+      assert_equal 31,@lesson.cards_count
+    end
+    
+    should "cache title" do
+      assert_equal "Part 3",@lesson.title
+    end
+    
+    should "cache language" do
+      assert_equal "ru",@lesson.language
+    end
+  end
+end

data/test/test_word.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestWord < Test::Unit::TestCase
+  context "word" do
+    setup do
+      @word = Lingq::Word.new("ru",{ "status"=> 0, 
+                                     "fragment"=> "вперед и вы найдете его .",
+                                     "term"=> "Его", 
+                                     "id"=> 4259928, 
+                                     "hint"=> "him" })
+    end
+    
+    should "cache status" do
+      assert_equal 0,@word.status
+    end
+    
+    should "cache fragment" do
+      assert_equal "вперед и вы найдете его .",@word.fragment
+    end
+    
+    should "cache id" do
+      assert_equal 4259928,@word.id
+    end
+    
+    should "cache term" do
+      assert_equal "Его",@word.term
+    end
+    
+    should "cache hint" do
+      assert_equal "him",@word.hint
+    end
+    
+    should "cache language" do
+      assert_equal "ru",@word.language
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: lingq
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Ethan Vizitei
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Gem for interacting with the API of lingq.com.  It's a language learning website, and it's pretty useful, but I want to be able to work on my flashcards offline.  This gem is being written to be included in a desktop client (and maybe eventually a mobile client), but will certainly still be useful as a standalone api wrapper for other projects that want to interact with Lingq.com
+email: ethan.vizitei@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .bundle/config
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/lingq.rb
+- lib/lingq/client.rb
+- lib/lingq/lesson.rb
+- lib/lingq/word.rb
+- lingq.gemspec
+- test/helper.rb
+- test/test_client.rb
+- test/test_lesson.rb
+- test/test_word.rb
+has_rdoc: true
+homepage: http://github.com/evizitei/lingq
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: API Wrapper for Lingq.com
+test_files: 
+- test/helper.rb
+- test/test_client.rb
+- test/test_lesson.rb
+- test/test_word.rb