big_ml 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.1.1
+- Casting method to_* added
+- Update and destroy methods in the instances
+- README updated
+
 ## 0.1.0
 - BigML::Authenticable
 - BigML::Source

data/README.md

@@ -1,44 +1,81 @@
 # BigML
 
-A Ruby wrapper for the [BigML REST API](https://bigml.com/developers)
+A Ruby wrapper for the [BigML REST API](https://bigml.com/developers), provides access to sources, datasets, models, and predictions. You can create, retrieve, update and delete 
 
-## Compile into system gems
+[![Build Status](https://secure.travis-ci.org/vigosan/big_ml.png?branch=master)](http://travis-ci.org/vigosan/big_ml)
+
+## Synopsis
+
+```ruby
+require 'rubygems'
+require 'big_ml'
 
-    rake build; rake install
+BigML.configure do |c|
+  c.username = 'foo'
+  c.api_key = 'bar'
+end
+
+# easy creation of sources
+file_path = "fixtures/iris.csv"
+source = BigML::Source.create(file_path)
+
+# Are you looking for old dataset?
+all_datasets = BigML::Dataset.all
+
+# or just want to create one?
+dataset = source.to_dataset
+
+# find a concrete one 
+model = BigML::Model.find("4fe8868a035d07682f002891")
+
+# create you predictions using parameters...
+prediction = BigML::Prediction.create(model.resource, { :input_data => { "000001" => 3 }})
+prediction.destroy
+
+# you can destroy everything!
+BigML::Model.delete("4fe8868a035d07682f002891")
+
+```
 
 ## Installation
 
+### Bundler
+
 Add this line to your application's Gemfile:
 
+    source 'https://rubygems.org'
     gem 'big_ml'
 
-And then execute:
+And then install the new dependencies with:
 
-    $ bundle
+    $ bundle install
 
-## Usage
+### Rubygems
 
-```ruby
-require 'big_ml'
+Install the gem with rubygem in your system:
 
-BigML.configure do |c|
-  c.username = 'foo'
-  c.api_key = 'bar'
-end
+    $ gem install big_ml
+
+### Dependencies
+
+- httparty
 
-source = BigML::Source.create("spec/fixtures/iris.csv")
-dataset = BigML::Dataset.create(source.resource)
-model = BigML::Model.create(dataset.resource)
-prediction = BigML::Prediction.create(model.resource, { :input_data => { "000001" => 3 }})
-```
 
 ## Ruby Interpreter Compatibility
+
 This library has been tested on the following ruby interpreters:
 
 * MRI 1.9.2
 * MRI 1.9.3
 
-[![Build Status](https://secure.travis-ci.org/vigosan/big_ml.png?branch=master)](http://travis-ci.org/vigosan/big_ml)
+## Running the tests 
+
+Download and run the test suit:
+
+    $ git clone git@github.com:vigosan/big_ml.git
+    $ cd big_ml
+    $ bundle install
+    $ rspec spec
 
 ## Contributing
 

data/big_ml.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://bigml.com"
 
   gem.add_dependency              "httmultiparty"
+  gem.add_dependency              "json"
   gem.add_development_dependency  "rake"
   gem.add_development_dependency  "rspec"
   gem.add_development_dependency  "vcr"

data/lib/big_ml/base.rb

@@ -1,17 +1,27 @@
+require 'big_ml/util/client'
+
 module BigML
   class Base
-     attr_accessor :attrs
+    attr_accessor :attrs
+
+    def initialize(attrs = {})
+      @attrs = attrs.dup
+      @attrs.each { |key, value|
+        instance_variable_set("@#{key}".to_sym, value)
+      }
+    end
 
-     def initialize(attrs = {})
-        @attrs = attrs.dup
-        @attrs.each { |key, value|
-          instance_variable_set("@#{key}".to_sym, value)
-        }
-     end
+    def id
+      resource.split('/').last
+    end
 
-     def id
-       resource.split('/').last
-     end
+    def destroy
+      self.class.delete(id)
+    end
+
+    def update(options)
+      self.class.update(id, options)
+    end
 
     class << self
       def all(options = {})
@@ -40,7 +50,7 @@ module BigML
       private
 
       def client
-        @client ||= Client.new
+        @client ||= Util::Client.new
       end
 
       def resource_name

data/lib/big_ml/dataset.rb

@@ -1,3 +1,5 @@
+require 'big_ml/base'
+
 module BigML
   class Dataset < Base
     DATASET_PROPERTIES = [
@@ -5,15 +7,19 @@ module BigML
       :description, :fields, :locale, :name, :number_of_models,
       :number_of_predictions, :private, :resource, :rows, :size,
       :source, :source_status, :status, :tags, :updated
-     ]
+    ]
+
+    attr_reader *DATASET_PROPERTIES
 
-     attr_reader *DATASET_PROPERTIES
+    def to_model
+      Model.create(resource)
+    end
 
-     class << self
+    class << self
       def create(source, options = {})
         response = client.post("/#{resource_name}", options, { :source => source })
         self.new(response) if response.success?
       end
-     end
+    end
   end
 end

data/lib/big_ml/model.rb

@@ -1,21 +1,27 @@
+require 'big_ml/base'
+
 module BigML
   class Model < Base
     MODEL_PROPERTIES = [
-       :category, :code, :columns, :created, :credits, 
-       :dataset, :dataset_status, :description, :holdout, 
-       :input_fields, :locale, :max_columns, :max_rows, :model, 
-       :name, :number_of_predictions, :objective_fields, :private, 
-       :range, :resource, :rows, :size, :source, :source_status, 
-       :status, :tags, :updated
-     ]
+      :category, :code, :columns, :created, :credits, 
+      :dataset, :dataset_status, :description, :holdout, 
+      :input_fields, :locale, :max_columns, :max_rows, :model, 
+      :name, :number_of_predictions, :objective_fields, :private, 
+      :range, :resource, :rows, :size, :source, :source_status, 
+      :status, :tags, :updated
+    ]
+
+    attr_reader *MODEL_PROPERTIES
 
-     attr_reader *MODEL_PROPERTIES
+    def to_prediction(options)
+      Prediction.create(resource, options)
+    end
 
-     class << self
+    class << self
       def create(dataset, options = {})
         response = client.post("/#{resource_name}", options, { :dataset => dataset })
         self.new(response) if response.success?
       end
-     end
+    end
   end
 end

data/lib/big_ml/prediction.rb

@@ -1,3 +1,5 @@
+require 'big_ml/base'
+
 module BigML
   class Prediction < Base
     PREDICTION_PROPERTIES = [
@@ -5,15 +7,15 @@ module BigML
       :description, :fields, :input_data, :model, :model_status, :name, 
       :objective_fields, :prediction, :prediction_path, :private, :resource, 
       :source, :source_status, :status, :tags, :updated
-     ]
+    ]
 
-     attr_reader *PREDICTION_PROPERTIES
+    attr_reader *PREDICTION_PROPERTIES
 
-     class << self
+    class << self
       def create(model, options = {})
         response = client.post("/#{resource_name}", {}, { :model => model }.merge!(options))
         self.new(response) if response.success?
       end
-     end
+    end
   end
 end

data/lib/big_ml/source.rb

@@ -1,18 +1,24 @@
+require 'big_ml/base'
+
 module BigML
   class Source < Base
     SOURCE_PROPERTIES = [
       :code, :content_type, :created, :credits, :fields, :file_name, :md5, 
       :name, :number_of_datasets, :number_of_models, :number_of_predictions, 
       :private, :resource, :size, :source_parser, :status, :type, :updated
-     ]
+    ]
+
+    attr_reader *SOURCE_PROPERTIES
 
-     attr_reader *SOURCE_PROPERTIES
+    def to_dataset
+      Dataset.create(resource)
+    end
 
-     class << self
+    class << self
       def create(file, options = {})
         response = client.post("/#{resource_name}", options.merge(:multipart => true, :file => File.new(file)))
         self.new(response) if response.success?
       end
-     end
+    end
   end
 end

data/lib/big_ml/util/client.rb

@@ -0,0 +1,26 @@
+require 'httmultiparty'
+require 'big_ml/util/authenticable'
+require 'big_ml/util/config'
+require 'big_ml/util/request'
+
+module BigML
+  module Util
+    class Client
+      include HTTMultiParty
+      include Authenticable
+      include Request
+      format :json
+
+      base_uri Config::BIGML_ENDPOINT
+
+      attr_accessor *Config::VALID_OPTIONS_KEYS
+
+      def initialize(attrs={})
+        attrs = BigML.options.merge(attrs)
+        Config::VALID_OPTIONS_KEYS.each { |key|
+          instance_variable_set("@#{key}".to_sym, attrs[key])
+        }
+      end
+    end
+  end
+end

data/lib/big_ml/util/config.rb

@@ -0,0 +1,32 @@
+module BigML
+  module Util
+    module Config
+      # The endpoint that will be used to connect if none is set
+      BIGML_ENDPOINT         = "https://bigml.io/andromeda"
+      # The username if none is set
+      DEFAULT_BIGML_USERNAME = nil
+      # The api key if none is set
+      DEFAULT_BIGML_API_KEY  = nil
+      # An array of valid keys in the options hash when configuring a {BigML::Client}
+      VALID_OPTIONS_KEYS     = [:username, :api_key]
+
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      def configure
+        yield self
+        self
+      end
+
+      def options
+        options = {}
+        VALID_OPTIONS_KEYS.each{ |k| options[k] = send(k) }
+        options
+      end
+
+      def reset
+        self.username = DEFAULT_BIGML_USERNAME
+        self.api_key  = DEFAULT_BIGML_API_KEY
+      end
+    end
+  end
+end

data/lib/big_ml/version.rb

@@ -1,3 +1,3 @@
 module BigML
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/big_ml.rb

@@ -1,9 +1,13 @@
-require 'big_ml/version'
-require 'big_ml/client'
-require 'big_ml/config'
+require 'big_ml/util/client'
+require 'big_ml/model'
+require 'big_ml/dataset'
+require 'big_ml/prediction'
+require 'big_ml/source'
+
+require 'big_ml/util/config'
 
 module BigML
-  extend Config
+  extend Util::Config
 
   class << self
     def new(options = {})

data/spec/integration/dataset_spec.rb

@@ -42,10 +42,27 @@ describe BigML::Dataset, :vcr do
       BigML::Dataset.find(@dataset.id).name.should == 'foo name'
     end
 
+    it "must be able to update the name from the instance" do
+      @dataset.update(:name => 'foo name').code.should == 202
+      BigML::Dataset.find(@dataset.id).name.should == 'foo name'
+    end
+
+    it "must be able to be deleted using the destroy method" do
+      dataset_id = @dataset.id
+      @dataset.destroy
+      BigML::Dataset.find(dataset_id).should be_nil
+    end
+
     it "must be able to remove the dataset" do
       BigML::Dataset.delete(@dataset.id)
       BigML::Dataset.find(@dataset.id).should be_nil
       BigML::Dataset.all.should have(0).datasets
     end
+
+    it "can be converted in a model" do
+      model = @dataset.to_model
+      model.instance_of?(BigML::Model).should be_true
+      model.code.should == 201
+    end
   end
 end

data/spec/integration/model_spec.rb

@@ -44,10 +44,27 @@ describe BigML::Model, :vcr do
       BigML::Model.find(@model.id).name.should == 'foo name'
     end
 
+    it "must be able to update the name from the instance" do
+      @model.update( :name => 'foo name' ).code.should == 202
+      BigML::Model.find(@model.id).name.should == 'foo name'
+    end
+
     it "must be able to remove the model" do
       BigML::Model.delete(@model.id)
       BigML::Model.find(@model.id).should be_nil
       BigML::Model.all.should have(0).models
     end
+
+    it "must be able to be deleted using the destroy method" do
+      model_id = @model.id
+      @model.destroy
+      BigML::Model.find(model_id).should be_nil
+    end
+
+    it "can be converted in a prediction" do
+      prediction = @model.to_prediction(:input_data => { "000001" => 3 })
+      prediction.instance_of?(BigML::Prediction).should be_true
+      prediction.code.should == 201
+    end
   end
 end

data/spec/integration/prediction_spec.rb

@@ -46,10 +46,21 @@ describe BigML::Prediction, :vcr do
       BigML::Prediction.find(@prediction.id).name.should == 'foo name'
     end
 
+    it "must be able to update the name from the instance" do
+      @prediction.update( :name => 'foo name' ).code.should == 202
+      BigML::Prediction.find(@prediction.id).name.should == 'foo name'
+    end
+
     it "must be able to remove the prediction" do
       BigML::Prediction.delete(@prediction.id)
       BigML::Prediction.find(@prediction.id).should be_nil
       BigML::Prediction.all.should have(0).predictions
     end
+
+    it "must be able to be deleted using the destroy method" do
+      prediction_id = @prediction.id
+      @prediction.destroy
+      BigML::Prediction.find(prediction_id).should be_nil
+    end
   end
 end

data/spec/integration/source_spec.rb

@@ -3,12 +3,7 @@ require "spec_helper"
 describe BigML::Source, :vcr do
 
   before(:each) do
-    BigML::Source.all.each do |s|
-      BigML::Source.delete(s.id)
-    end
-    BigML::Dataset.all.each do |s|
-      BigML::Dataset.delete(s.id)
-    end
+    BigML::Source.delete_all
   end
 
   describe "no source" do
@@ -46,10 +41,28 @@ describe BigML::Source, :vcr do
       BigML::Source.find(@source.id).name.should == 'new name'
     end
 
+    it "must be able to update the name from the instance" do
+      BigML::Source.find(@source.id).name.should == 'iris.csv'
+      @source.update( :name => 'new name' ).code.should == 202
+      BigML::Source.find(@source.id).name.should == 'new name'
+    end
+
     it "must be able to remove the source" do
       BigML::Source.delete(@source.id)
       BigML::Source.find(@source.id).should be_nil
       BigML::Source.all.should have(0).sources
     end
+
+    it "must be able to be deleted using the destroy method" do
+      source_id = @source.id
+      @source.destroy
+      BigML::Source.find(source_id).should be_nil
+    end
+
+    it "can be converted in a dataset" do
+      dataset = @source.to_dataset
+      dataset.instance_of?(BigML::Dataset).should be_true
+      dataset.code.should == 201
+    end
   end
 end

data/spec/units/client_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe BigML::Client do
+describe BigML::Util::Client do
   let(:keys) {
-    BigML::Config::VALID_OPTIONS_KEYS
+    BigML::Util::Config::VALID_OPTIONS_KEYS
   }
 
   context "module configuration" do
@@ -13,7 +13,7 @@ describe BigML::Client do
     }
 
     it "should inherit module configuration" do
-      api = BigML::Client.new
+      api = BigML::Util::Client.new
       keys.each { |key| api.send(key).should == key }
     end
   end
@@ -28,7 +28,7 @@ describe BigML::Client do
 
     context "during initialization" do
       it "should override module configuration" do
-        api = BigML::Client.new(credentials)
+        api = BigML::Util::Client.new(credentials)
         keys.each { |key| api.send(key).should == credentials[key] }
       end
     end
@@ -41,7 +41,7 @@ describe BigML::Client do
       }
 
       it "should override module configuration" do
-        api = BigML::Client.new
+        api = BigML::Util::Client.new
         credentials.each { |key, value| api.send("#{key}=", value) }
         keys.each { |key| api.send(key).should == credentials[key] }
       end