wepredict 0.1.0 → 0.2.0

data/Gemfile

@@ -1,11 +1,11 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+
+gem "thor", "~> 0.14.6"
+gem "yajl-ruby", "~> 0.8.3"
 
 # Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "rdoc", "~> 3.9.4"
   gem "rspec", "~> 2.6.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"

data/Gemfile.lock

@@ -8,6 +8,7 @@ GEM
       git (>= 1.2.5)
       rake
     rake (0.9.2)
+    rdoc (3.9.4)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -16,6 +17,8 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
+    thor (0.14.6)
+    yajl-ruby (0.8.3)
 
 PLATFORMS
   ruby
@@ -23,4 +26,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.6.4)
+  rdoc (~> 3.9.4)
   rspec (~> 2.6.0)
+  thor (~> 0.14.6)
+  yajl-ruby (~> 0.8.3)

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'bundler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,6 +10,7 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
+
 require 'rake'
 
 require 'jeweler'
@@ -21,21 +23,17 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Provides easy access to the WePredict data mining API}
   gem.email = "ben@benmcredmond.com"
   gem.authors = ["Ben McRedmond"]
+  gem.executables = ["wepredict"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
 
 require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/wepredict

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if ENV['WP_DEV']
+  base = File.expand_path(File.dirname(File.dirname(__FILE__)))
+  $:.push("#{base}/lib/")
+end
+
+require "wepredict/cli"
+WePredict::CLI::CLI.start

data/lib/wepredict/api.rb

@@ -0,0 +1,55 @@
+require 'net/http'
+require 'uri'
+require 'yajl'
+
+require 'wepredict/exceptions'
+
+module WePredict
+  class API
+
+    @@endpoint = URI.parse((ENV["WP_DEV"]) ? "http://wepredict.dev/api/" : "http://demo.wepredictapp.com/api/")
+
+    # Makes a request to the WePredict API if the API
+    # encounters an error, a WePredictError is raised
+    # containing the error message and the response body
+    def self.make_request(method, params)
+      res = Net::HTTP.start(@@endpoint.host, @@endpoint.port) do |h|
+        query_string = params.map {|k,v| "#{k}=#{v}"}.join('&')
+        h.get("#{@@endpoint.path}#{method}?#{URI.escape(query_string)}")
+      end
+
+      json = Yajl::Parser.parse(res.body, :symbolize_keys => true)
+      if(json.kind_of?(Hash) && json[:state] == 'error')
+        ex = case json[:code]
+          when 400
+            Errors::BadRequest
+          when 403
+            Errors::AccessDenied
+        end
+
+        raise ex.new(json), json[:message]
+      end
+
+      json
+    end
+
+    # @@endpoint accessor
+    def self.endpoint
+      @@endpoint
+    end
+
+    protected 
+    # Checks the correct paramaters were passed to a method    
+    def self.params?(params, required)
+      required.each do |r|
+        raise ArgumentError, "Paramater, #{r}, is missing" if params[r].nil?
+      end
+    end
+
+    def self.class_name
+      n = self.name.split('::').last.scan(/[A-Z][^A-Z]*/)
+      n.map {|o| o.downcase}.join('_') 
+    end
+
+  end
+end

data/lib/wepredict/classifier.rb

@@ -0,0 +1,24 @@
+module WePredict
+  module Classifiers
+    class Classifier < API
+      
+      def initialize
+        @api_key = Classifier.api_key
+      end
+
+      def self.classify(options)
+        params? options, [:text]
+        make_request("classifiers/#{self.class_name}/classify", options.merge(:api_key => self.api_key))
+      end
+
+      def self.api_key
+        f = File.open(File.expand_path("~/.wepredict"), 'r')
+        k = f.read(32)
+        f.close
+
+        k
+      end
+
+    end
+  end
+end

data/lib/wepredict/classifiers/sentiment.rb

@@ -0,0 +1,6 @@
+module WePredict
+  module Classifiers
+    class Sentiment < Classifier
+    end
+  end
+end

data/lib/wepredict/cli/user.rb

@@ -0,0 +1,155 @@
+require 'thor'
+require 'wepredict/user'
+
+module WePredict
+  module CLI
+    class User < Thor
+
+      include Thor::Actions
+
+      desc "signup EMAIL", "Signup for WePredict"
+      def signup(email)
+        begin
+          password = capture_password(true)
+          u = WePredict::User.create(:email => email, :password => password)
+        rescue WePredict::Errors::BadRequest => e
+          if(e.body[:error] == "user_exists")
+            say "User already exists, maybe try logging in?", :red
+            exit
+          end
+
+          say e.message, :red
+          retry
+        end
+
+        say "\nThankyou for signing up for WePredict", :green
+        write_api_key(u[:api_key])
+      end
+
+      desc "login EMAIL", "Login to your WePredict account (will save API key in ~/.wepredict)"
+      def login(email)
+        password = capture_password
+        begin
+          u = WePredict::User.get(:email => email, :password => password)
+        rescue WePredict::Errors::AccessDenied => e
+          say e.message, :red
+          retry
+        end
+
+        write_api_key(u[:api_key])
+      end
+
+      desc "delete EMAIl", "Delete your WePredict account"
+      def delete(email)
+        password = capture_password
+        confirm = yes?("Are you sure you want to close your account? This is non-reversable (y/n):")
+
+        if !confirm
+          say "Phew, almost lost you there!" 
+          exit
+        end
+
+        begin
+          WePredict::User.delete(:email => email, :password => password)
+        rescue WePredict::Errors::AccessDenied => e
+          say e.message, :red
+          retry
+        end
+        
+        say "Sucessfully closed your WePredict account", :green
+      end
+
+      desc "change_password EMAIL", "Change the password for your WePredict account"
+      def change_password(email)
+        password = authenticate(email)
+        new_password = capture_password(true)
+        WePredict::User.change_password(:email => email, :password => password, :new_password => new_password)
+
+        say "Sucessfully changed your password", :green
+      end
+
+      desc "change_email EMAIL NEW_EMAIL", "Change your EMAIL to NEW_EMAIL"
+      def change_email(email, new_email)
+        password = authenticate(email)
+        WePredict::User.change_email(:email => email, :password => password, :new_email => email)
+        
+        say "Sucessfully changed your email address", :green
+      end
+
+      desc "forgotten_password EMAIL", "Reset your password"
+      def forgotten_password(email)
+        begin
+          WePredict::User.forgotten_password(:email => email)
+        rescue WePredict::Errors::BadRequest
+          say "We can't find you! Maybe you want to signup instead?", :red
+          exit
+        end
+        
+        say "We have sent you a super secret code to your email, go check your email and then enter the code here!"
+        begin
+          code = ask "Super secret code:"
+          password = capture_password(true)
+          WePredict::User.reset_forgotten_password(:email => email, :forgotten_password_code => code, :new_password => password)
+        rescue WePredict::Errors::AccessDenied
+          say "That's not the right super secret code! Try again", :red
+          retry
+        end
+
+        say "Sucessfully reset your password", :green
+      end
+
+      def self.banner(task, namespace = true, subcommand = false)
+        "#{basename} #{self.name.split('::').last.downcase} #{task.formatted_usage(self, false, subcommand)}"
+      end
+
+      private
+      def authenticate(email)
+        begin
+          password = capture_password 
+          WePredict::User.get(:email => email, :password => password)
+        rescue WePredict::Errors::AccessDenied => e
+          say e.message, :red
+          retry 
+        end
+
+        password
+      end
+
+      def write_api_key(api_key)
+        f = File.open(File.expand_path("~/.wepredict"), 'w')
+        f.write api_key
+        f.close
+
+        say "Your api key has been saved in ~/.wepredict", :green
+      end
+
+      def capture_password(new_password = false)
+        begin
+          system("stty -echo")
+
+          password = ask((new_password) ? "Please enter a password (>= 6 chars):" : "Password:")
+          print "\n"
+
+          raise ArgumentError if(password.length < 6)
+          raise RuntimeError if(new_password && password != ask("Please confirm your password:"))
+        rescue ArgumentError
+          print "\n"
+          say "Password is too short, please try again", :red
+
+          retry
+        rescue RuntimeError
+          print "\n\n"
+          say "Passwords don't match, please try again", :red
+
+          retry
+        ensure
+          system("stty echo")
+          print "\n"
+        end
+        
+        password
+      end
+
+    end
+  end
+end

data/lib/wepredict/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+require 'thor/group'
+
+require 'wepredict/cli/user'
+
+module WePredict
+  module CLI
+    class CLI < Thor
+
+      register WePredict::CLI::User, :user, "user", "Commands for interacting with a user"
+
+    end
+  end
+end

data/lib/wepredict/exceptions.rb

@@ -0,0 +1,16 @@
+module WePredict
+  module Errors
+
+    class APIError < StandardError 
+      attr_reader :body
+
+      def initialize(body)
+        @body = body
+      end
+    end
+
+    class BadRequest < APIError; end
+    class AccessDenied < APIError; end
+
+  end
+end

data/lib/wepredict/user.rb

@@ -0,0 +1,37 @@
+require 'wepredict/api'
+
+module WePredict
+ class User < API 
+
+    @@methods_and_required_params = {:create => [:email, :password], 
+                                     :get => [:email, :password], 
+                                     :new_api_key => [:email, :password],
+                                     :change_password => [:email, :password, :new_password],
+                                     :change_email => [:email, :password, :new_email],
+                                     :delete => [:email, :password],
+                                     :forgotten_password => [:email],
+                                     :reset_forgotten_password => [:email, :forgotten_password_code, :new_password]}
+
+    # Implements method calles for all the methods defined
+    # in @@methods_and_required_params which is intuitively
+    # a map of method names to their required paramaters.
+    def self.method_missing(method_name, *args, &block)
+      if(respond_to?(method_name))
+        params? *args, @@methods_and_required_params[method_name] 
+
+        method_name = "#{class_name.downcase}/#{method_name}"
+
+        make_request(method_name, *args)
+      else
+        super
+      end
+    end
+        
+    # Implements correct respond_to? behaviour for
+    # methods defined through method_missing
+    def self.respond_to?(method_name)
+      !!@@methods_and_required_params[method_name] || super
+    end
+    
+  end
+end

data/lib/wepredict.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+
+require "wepredict/api"
+require "wepredict/classifier"
+require "wepredict/classifiers/sentiment"
+require "wepredict/exceptions"
+require "wepredict/user"

data/spec/wepredict/user_spec.rb

@@ -0,0 +1,28 @@
+require './lib/wepredict/user'
+
+module WePredict
+  describe User do
+
+    # All the other user methods are implemented
+    # in the same way (through method_missing), so,
+    # we only test one.
+    describe "#create" do
+      it "fails if you don't provide an :email and :password" do
+        expect {
+          User.create(:email => "ben@example.com")
+        }.to raise_error(ArgumentError, /missing/)
+
+        expect {
+          User.create(:password => "super secret sauce")
+        }.to raise_error(ArgumentError, /missing/)
+      end
+
+      it "sends an api request to create a user" do
+        u = {:email => "ben@example.com", :password => "super secret sauce"} 
+        User.should_receive(:make_request).with('user/create', u).and_return(true)
+        User.create(u)
+      end
+    end
+
+  end
+end

data/wepredict.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wepredict}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Ben McRedmond}]
+  s.date = %q{2011-09-06}
+  s.description = %q{Provides easy access to the WePredict data mining API}
+  s.email = %q{ben@benmcredmond.com}
+  s.executables = [%q{wepredict}]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/wepredict",
+    "lib/wepredict.rb",
+    "lib/wepredict/api.rb",
+    "lib/wepredict/classifier.rb",
+    "lib/wepredict/classifiers/sentiment.rb",
+    "lib/wepredict/cli.rb",
+    "lib/wepredict/cli/user.rb",
+    "lib/wepredict/exceptions.rb",
+    "lib/wepredict/user.rb",
+    "spec/wepredict/user_spec.rb",
+    "wepredict.gemspec"
+  ]
+  s.homepage = %q{http://github.com/benofsky/WePredict-Client}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.7}
+  s.summary = %q{Client gem for WePredict}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<thor>, ["~> 0.14.6"])
+      s.add_runtime_dependency(%q<yajl-ruby>, ["~> 0.8.3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.9.4"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<thor>, ["~> 0.14.6"])
+      s.add_dependency(%q<yajl-ruby>, ["~> 0.8.3"])
+      s.add_dependency(%q<rdoc>, ["~> 3.9.4"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<thor>, ["~> 0.14.6"])
+    s.add_dependency(%q<yajl-ruby>, ["~> 0.8.3"])
+    s.add_dependency(%q<rdoc>, ["~> 3.9.4"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wepredict
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,44 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-03 00:00:00.000000000Z
+date: 2011-09-06 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70118865907720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70118865907720
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70118865904580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70118865904580
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70118865900420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.9.4
+  type: :development
+  prerelease: false
+  version_requirements: *70118865900420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70260187847580 !ruby/object:Gem::Requirement
+  requirement: &70118865899580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +54,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70260187847580
+  version_requirements: *70118865899580
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70260187845460 !ruby/object:Gem::Requirement
+  requirement: &70118865897720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70260187845460
+  version_requirements: *70118865897720
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70260187843700 !ruby/object:Gem::Requirement
+  requirement: &70118865896340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +76,11 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70260187843700
+  version_requirements: *70118865896340
 description: Provides easy access to the WePredict data mining API
 email: ben@benmcredmond.com
-executables: []
+executables:
+- wepredict
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -58,9 +92,17 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/wepredict
 - lib/wepredict.rb
-- test/helper.rb
-- test/test_wepredict.rb
+- lib/wepredict/api.rb
+- lib/wepredict/classifier.rb
+- lib/wepredict/classifiers/sentiment.rb
+- lib/wepredict/cli.rb
+- lib/wepredict/cli/user.rb
+- lib/wepredict/exceptions.rb
+- lib/wepredict/user.rb
+- spec/wepredict/user_spec.rb
+- wepredict.gemspec
 homepage: http://github.com/benofsky/WePredict-Client
 licenses:
 - MIT
@@ -76,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3889679430223307924
+      hash: 3624294656438796082
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'wepredict'
-
-class Test::Unit::TestCase
-end

data/test/test_wepredict.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestWepredict < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end