ubidots 0.0.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 7f9139ab686fb7dc1cafcf9425c0f669c4e07925
-  data.tar.gz: 6581b65a533950e99809d8358ade91e8148de489
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTY3OWMyNzA1NGU0YWUyZjg3MWI3ZjM0NGNjMWM1ZWViM2VhODJlZQ==
+  data.tar.gz: !binary |-
+    NjU1YjU5ZmM5YThmNDNjNzVjZWZkZjEyYTk4YWJiYTY2NTlhNjIyNA==
 SHA512:
-  metadata.gz: faad8b8591445655428b583e7e3facbb13393c1a9633cc4a255c281fa59849aaaf80498f41a70912ffb9b544a2ca08160bb022a82330fb335f6bad508ea3ddd4
-  data.tar.gz: 0dfcafe5c4f5c15bc7fb5ee27c8707312cb44f1ba1d2c691a673f60aa358234219728f0bc0268d34b92918de161ac551614e8f855f6df370c15bce24d7cc6aba
+  metadata.gz: !binary |-
+    MTU0OTRjY2UwNTIzYzAxNTQ3MGI0ZjJjMGIyZjlmNjQwZTRmYzlhZjM3YWQ5
+    YzcyNDBlYWZjZjBiZTAzMzliNjJiOGY5NmQ5OWRiYzUyODIxMTYzYmVmMDJh
+    MGVkOWJhMDQ1ZWYxZGMxOWZmMTgwNTY4ODgzOWU5NzdhZmFkOWY=
+  data.tar.gz: !binary |-
+    MTk2MjE3NDllNzU1MmYxNGMzZGEwZjVkZDEzMDZlNmJjYWM4ZDE0N2ZlNjJl
+    NzUyYzg1NzY0Yzk4NWY3MTM2NmFmNmNmMzA2NjIxODgyZjEwNTc2M2YzOThh
+    Yjg5OTVmNmNjZDllZjBkNjNhMzI2YTQ1MDQ5NTYzMWZhYzdhMjQ=

data/README.rst

@@ -0,0 +1,148 @@
+===================================
+Ubidots Ruby API Client
+===================================
+
+The Ubidots Ruby API Client makes calls to the `Ubidots Api <http://things.ubidots.com/api>`_. 
+
+Installation
+------------
+
+Add this line to your application's Gemfile:.
+
+.. code-block:: ruby
+
+    gem 'ubidots'
+
+And then execute:
+
+.. code-block:: bash
+
+    $ bundle
+
+Or install it yourself as:
+
+.. code-block:: bash
+
+    $ gem install ubidots
+
+
+Connecting to the API
+----------------------
+
+Before playing with the API you should connect to it using your private API key, which can be found `in your profile <http://app.ubidots.com/userdata/api/>`_.
+
+If you don't have an account yet, you can `create one here <http://app.ubidots.com/accounts/signup/>`_.
+
+Once you have your API key, you can connect to the API by creating an ApiClient instance. Let's assume your API key is: "7fj39fk3044045k89fbh34rsd9823jkfs8323". Then your code would look like this:
+
+
+.. code-block:: ruby
+
+    require 'ubidots'
+    
+    @api = Ubidots::ApiClient.new("7fj39fk3044045k89fbh34rsd9823jkfs8323")
+
+
+Now you have an instance of ApiClient ("api") which can be used to connect to the Ubidots API.
+
+Saving a new Value to a Variable
+--------------------------------
+
+Retrieve the variable you'd like the value to be saved to:
+
+.. code-block:: ruby
+    
+    my_variable = @api.get_variable('56799cf1231b28459f976417')
+
+Given the instantiated variable, you can save a new value with the following line:
+
+.. code-block:: ruby
+    
+    new_value = my_variable.save_value( {'value'=>10} )
+
+You can also specify a timestamp (optional):
+
+.. code-block:: ruby
+
+    new_value = my_variable.save_value( {'value'=>10, 'timestamp'=>1376061804407} )
+
+If no timestamp is specified, the API server will assign the current time to it. We think it's always better for you to specify the timestamp so the record reflects the exact time the value was captured, not the time it arrived to our servers.
+
+Creating a Data Source
+----------------------
+
+As you might know by now, a data source represents a device that's generating time-series data.
+
+This line creates a new data source:
+
+.. code-block:: ruby
+    
+    new_datasource = @api.create_datasource( {"name"=>"myNewDs", "tags"=>["firstDs", "new"], "description"=>"any des"} )
+
+The 'name' key is required, but the 'tags' and 'description' keys are optional. This new data source can be used to track different variables, so let's create one.
+
+
+Creating a Variable
+--------------------
+
+A variable is a time-series containing different values over time. Let's create one:
+
+
+.. code-block:: ruby
+    
+    new_variable = new_datasource.create_variable( {"name"=>"myNewVar", "unit"=>"Nw"} )
+
+The 'name' and 'unit' keys are required.
+
+Getting Values
+--------------
+
+To get the values of a variable, use the method get_values in an instance of the class Variable. This will return a values array.
+
+If you only want the last N values call the method with the number of elements you want.
+
+.. code-block:: ruby
+    
+    all_values = my_variable.get_values()
+    
+
+Getting a group of Data Sources
+--------------------------------
+
+If you want to get all your data sources you can a method on the ApiClient instance directly. This method return a objects Datasource array.
+
+.. code-block:: ruby
+
+    all_datasources = @api.get_datasources()
+
+
+Getting a specific Data source
+-------------------------------
+
+Each data source is identified by an ID. A specific data source can be retrieved from the server using this ID.
+
+For example, if a data source has the id 51c99cfdf91b28459f976414, it can be retrieved as follows:
+
+
+.. code-block:: ruby
+
+    my_specific_datasource = @api.get_datasource('51c99cfdf91b28459f976414')
+
+Getting a group of Variables from a Data source
+-------------------------------------------------
+
+You can also retrieve some or all of the variables of a data source:
+
+.. code-block:: ruby
+
+    all_variables_of_datasource =  my_datasource.get_variables()
+
+
+Getting a specific Variable
+------------------------------
+
+As with data sources, you can use your variable's ID to retrieve the details about it:
+
+.. code-block:: ruby
+
+    my_specific_variable = @api.get_variable('56799cf1231b28459f976417')

data/lib/ubidots.rb

@@ -2,87 +2,53 @@ require "rest_client"
 require "json"
 require "ubidots/version"
 require "ubidots/constants"
-require "ubidots/user"
 require "ubidots/variable"
 require "ubidots/datasource"
-require "ubidots/util/collection_with_finders"
-require "ubidots/util/array"
+require "ubidots/server_bridge"
 
 module Ubidots
   include Constants
 
   class ApiClient  
    
-    def initialize(api_key=nil)
-      raise "Invalid API key: #{key}" if api_key.nil?  
-      @api_key = api_key
-      set_api_key_header
-      get_token
-      set_token_header
-    end
-
-    private
-
-    def get_token
-      endpoint = "auth/token/"
-      response = post_with_apikey endpoint
-      @token = response['token']
-    end
-
-    def set_api_key_header
-      @apikey_header = { 'X-UBIDOTS-APIKEY' => @api_key }
-    end
-
-    def set_token_header
-      @token_header = { 'X-AUTH-TOKEN' => @token }
-    end
-
-    def transform_to_datasource_objects(raw_items)
-      datasources = []
-      raw_items.each_with_index do |raw_item, i|
-        datasources[i] = Ubidots::Datasource.new(raw_item)
+    def initialize(api_key=nil, token=nil, base_url=nil, bridge=nil)
+      if bridge
+        @bridge = bridge
+      else
+        @bridge = Ubidots::ServerBridge.new(api_key, token, base_url)
       end
-      return datasources
-    end
-
-    def transform_to_variable_objects(raw_items)
-      variables = []
-      raw_items.each_with_index do |raw_item, i|
-        variables[i] = Ubidots::Variable.new(raw_item)
-      end
-      return variables
     end
 
     public
 
-    def post_with_apikey(endpoint)
-      headers = @apikey_header
-      response = RestClient.post "#{Ubidots::Constants::API_URL}#{endpoint}", {}, headers
-      return JSON.parse(response.body)
-    end
-
-    def get(endpoint)
-      headers = @token_header
-      response = RestClient.get "#{Ubidots::Constants::API_URL}#{endpoint}", headers
-      return JSON.parse(response.body)
-    end
-
     def get_datasources
-      response = get 'datasources'
+      response = @bridge.get 'datasources'
       raw_items = response["results"]
-      return transform_to_datasource_objects raw_items
+      return @bridge.transform_to_datasource_objects raw_items
     end
 
     def get_variables
-      response = get 'variables'
+      response = @bridge.get 'variables'
       raw_items = response["results"]
-      return transform_to_variable_objects raw_items
+      return @bridge.transform_to_variable_objects raw_items
+    end
+
+    def get_datasource(id=nil)
+      endpoint = "datasources/#{id}"
+      response = @bridge.get endpoint
+      return Ubidots::Datasource.new(@bridge, response)
     end
 
-    protected
+    def create_datasource(data)
+      endpoint = "datasources";
+      response = @bridge.post endpoint, data
+      return Ubidots::Datasource.new(@bridge, response)
+    end
 
-    def invalid?
-      !defined?(@@token) || !defined?(@@key)
+    def get_variable(id=nil)
+      endpoint = "variables/#{id}"
+      response = @bridge.get endpoint
+      return Ubidots::Variable.new(@bridge, response)
     end
 
   end

data/lib/ubidots/datasource.rb

@@ -1,11 +1,11 @@
-require 'ubidots/datasource_service'
 module Ubidots
   class Datasource
 
     attr_reader :id, :name, :url, :last_activity, :tags, :description, :created_at
     attr_reader :owner, :parent, :context, :variables_url, :number_of_variables
 
-    def initialize(data)
+    def initialize(bridge, data)
+      @bridge = bridge
       @id = data["id"]
       @name = data["name"]
       @url = data["url"]
@@ -22,18 +22,21 @@ module Ubidots
 
     def get_variables
       endpoint = "datasources/#{@id}/variables"
-      response = Ubidots::ApiClient::get endpoint
+      response = @bridge.get endpoint
       raw_items = response["results"]
-      return Ubidots::ApiClient::transform_to_variable_objects raw_items
+      return @bridge.transform_to_variable_objects raw_items
     end
-    
 
-    def variables
-      VariableService.retrieve_for_datasource(self)
+    def remove_datasource
+      endpoint = "datasources/#{@id}";
+      @bridge.delete endpoint
     end
 
-    def primary_key
-      name
+    def create_variable(data)
+      endpoint = "datasources/#{@id}/variables"
+      response = @bridge.post endpoint, data
+      return Ubidots::Variable.new(@bridge, response)
     end
+
   end
 end

data/lib/ubidots/server_bridge.rb

@@ -0,0 +1,87 @@
+module Ubidots
+  class ServerBridge
+
+    def initialize(api_key=nil, token=nil, base_url=nil)
+      @base_url = base_url ? base_url : Ubidots::Constants::API_URL
+      if api_key
+        @api_key = api_key
+        set_api_key_header
+        get_token
+        set_token_header
+      elsif token
+        @api_key = nil
+        @token = token
+        set_token_header
+      end
+    end
+
+    private 
+
+    def get_token
+      endpoint = "auth/token/"
+      response = post_with_apikey endpoint
+      @token = response['token']
+    end
+
+    def set_api_key_header
+      @apikey_header = { 'X-UBIDOTS-APIKEY' => @api_key }
+    end
+
+    def set_token_header
+      @token_header = { 'X-AUTH-TOKEN' => @token }
+    end
+
+    def prepare_data(data)
+      return data
+    end
+
+    public
+
+    def transform_to_datasource_objects(raw_items)
+      datasources = []
+      raw_items.each_with_index do |raw_item, i|
+        datasources[i] = Ubidots::Datasource.new(self, raw_item)
+      end
+      return datasources
+    end
+
+    def transform_to_variable_objects(raw_items)
+      variables = []
+      raw_items.each_with_index do |raw_item, i|
+        variables[i] = Ubidots::Variable.new(self, raw_item)
+      end
+      return variables
+    end
+
+    def post_with_apikey(endpoint)
+      headers = @apikey_header
+      response = RestClient.post "#{@base_url}#{endpoint}", {}, headers
+      return JSON.parse(response.body)
+    end
+
+    def get(endpoint)
+      headers = @token_header
+      response = RestClient.get "#{@base_url}#{endpoint}", headers
+      return JSON.parse(response.body)
+    end
+        
+    def get_with_url(url)
+      headers = @token_header
+      response = RestClient.get url, headers
+      return JSON.parse(response.body)
+    end
+
+
+    def post(endpoint, data)
+      headers = @token_header
+      data = prepare_data(data)
+      response = RestClient.post "#{@base_url}#{endpoint}", data, headers
+      return JSON.parse(response.body)
+    end
+
+    def delete(endpoint)
+      headers = @token_header
+      RestClient.delete "#{@base_url}#{endpoint}", headers
+    end
+  end
+end

data/lib/ubidots/variable.rb

@@ -1,12 +1,11 @@
-require 'ubidots/variable_service'
-
 module Ubidots
 	class Variable
 
 		attr_reader :id, :name, :url, :last_activity, :tags, :description, :created_at
 		attr_reader :icon, :unit, :raw_datasource, :properties, :values_url, :last_value
 
-		def initialize(data)
+		def initialize(bridge, data)
+			@bridge = bridge
 			@id = data["id"]
 			@name = data["name"]
 			@url = data["url"]
@@ -22,6 +21,38 @@ module Ubidots
 			@last_value = data["last_value"]
 		end
 
-	end
+		def get_values
+			endpoint = "variables/#{@id}/values"
+			response = @bridge.get endpoint
+			return response["results"] 
+		end
+
+    def save_value(data)
+      endpoint = "variables/#{@id}/values"
+      return @bridge.post endpoint, data
+    end
 
+		def save_values(data, force=false)
+			endpoint = "variables/#{@id}/values"
+			if force == true
+				endpoint = "#{endpoint}?force=true"
+			end
+			return @bridge.post endpoint, data
+		end
+
+    def remove_variable
+      endpoint = "variables/#{@id}"
+      return @bridge.delete endpoint
+    end
+
+    def get_datasource
+      if !@datasource
+      	datasource_id = @raw_datasource["id"]
+      	endpoint = "datasources/#{datasource_id}"
+	      response = @bridge.get endpoint
+      	@datasource = Ubidots::Datasource.new(@bridge, response) 
+      end
+      return @datasource
+    end
+	end
 end

data/lib/ubidots/version.rb

@@ -1,3 +1,3 @@
 module Ubidots
-  VERSION = "0.0.1"
+  VERSION = "1.6.0"
 end

data/ubidots.gemspec

@@ -6,18 +6,19 @@ require 'ubidots/version'
 Gem::Specification.new do |gem|
   gem.name          = "ubidots"
   gem.version       = Ubidots::VERSION
-  gem.authors       = ["Federico Builes"]
-  gem.email         = ["federico.builes@gmail.com"]
-  gem.description   = "Ruby library to access the Ubidots API"
+  gem.authors       = ["Federico Builes", "Julián Hernandez"]
+  gem.email         = ["federico.builes@gmail.com", "julian@ubidots.com"]
+  gem.description   = "Official Ruby library for the Ubidots API"
   gem.summary       = "Ruby library to access the Ubidots API"
-  gem.homepage      = ""
+  gem.homepage      = "http://ubidots.com"
+  gem.licenses      = ['MIT']
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency("rest-client")
-  gem.add_dependency("json")
-  gem.add_development_dependency("rspec")
+  gem.add_dependency "rest-client", "~> 1.6"
+  gem.add_dependency "json", "~> 1.8"
+  gem.add_development_dependency "rspec", "~> 2.14"
 end

metadata

@@ -1,81 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: ubidots
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Federico Builes
+- Julián Hernandez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: Ruby library to access the Ubidots API
+        version: '2.14'
+description: Official Ruby library for the Ubidots API
 email:
 - federico.builes@gmail.com
+- julian@ubidots.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rvmrc"
+- .gitignore
+- .rspec
+- .rvmrc
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.rst
 - Rakefile
 - lib/ubidots.rb
 - lib/ubidots/constants.rb
 - lib/ubidots/datasource.rb
-- lib/ubidots/datasource_service.rb
-- lib/ubidots/user.rb
-- lib/ubidots/user_service.rb
+- lib/ubidots/server_bridge.rb
 - lib/ubidots/util/array.rb
 - lib/ubidots/util/collection_with_finders.rb
 - lib/ubidots/variable.rb
-- lib/ubidots/variable_service.rb
 - lib/ubidots/version.rb
 - spec/collection_with_finders_spec.rb
 - spec/datasource_spec.rb
@@ -83,8 +82,9 @@ files:
 - spec/ubidots_spec.rb
 - spec/user_spec.rb
 - ubidots.gemspec
-homepage: ''
-licenses: []
+homepage: http://ubidots.com
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -92,12 +92,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/README.md

@@ -1,86 +0,0 @@
-# Ubidots
-
-Ruby gem for connecting to the [Ubidots](http://ubidots.com) API.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'ubidots'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ubidots
-
-## Usage
-
-### Getting an API token
-
-The first thing you need to do to start using the API is to get a token. For this you'll need to
-obtain your account API key on the website and then call `Ubidots.api_key`:
-
-       Ubidots.api_key("458cacdd594246daf5126bf106ccaaefabf1bf56")
-
-
-### Users
-
-After getting your application token you can get a user object by calling:
-
-    user = Ubidots::User.find("username")
-
-This user has an associated set of datasources that you can retrieve like this:
-
-    user = Ubidots::User.find("username")
-    user.datasources      # => [...]
-
-#### Profiles
-
-You can see the user's profile by calling `#profile` on your user object:
-
-    user = Ubidots::User.find("username")
-    user.profile      # => { followers: 11, following: 24...}
-
-### Data Sources
-
-The datasources for the logged in user can be retrieved by doing:
-
-    Ubidots.datasources
-
-For a specific datasources you can pass the `datasource_id` to the `#find` method:
-
-    source = Ubidots.datasources.find(datsource_id)
-
-And you can read the variables from this datsources:
-
-    source = Ubidots.datasources.find(datsource_id)
-    variables = source.variables
-
-### Variables
-
-To obtain a list of the variables associated to the current user you can call:
-
-    Ubidots.variables
-
-For a specific variable just call `#find` on the variables collection and pass it the `variable_id`:
-
-    Ubidots.variables.find(variable_id)
-
-#### Values
-
-Each variable has a list of values. To obtain these just call `#values` on the specific variable:
-
-    variable = Ubidots.variables.find(variable_id)
-    values = variable.values
-
-You can get specific information about each value by passing a `value_id`:
-
-    values = Ubidots.variables.find(variable_id).values
-    value = values.find(value_id)
-
-
-### Error Handling
-### Query parameters

data/lib/ubidots/datasource_service.rb

@@ -1,17 +0,0 @@
-require 'ubidots/datasource'
-
-module Ubidots
-  class DatasourceService
-    def self.retrieve(username)
-      url = "#{Ubidots::API_URL}/users/#{username}/datasources/"
-      response = RestClient.get url, { "X-UbidotsApiKey" => @@key }
-      JSON.parse(response.body).to_collection_with_finders
-    end
-
-    def self.retrieve_without_username
-      url = "#{Ubidots::API_URL}/users/datasources/"
-      response = RestClient.get url, Ubidots::default_headers
-      JSON.parse(response.body).to_collection_with_finders
-    end
-  end
-end

data/lib/ubidots/user.rb

@@ -1,29 +0,0 @@
-require 'ubidots/user_service'
-
-module Ubidots
-  class User
-    attr_reader :datasources, :variables, :followers, :following
-    attr_reader :created_at, :blog, :username, :profile
-
-    def initialize(params={})
-      @profile = params
-      @profile.each do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-    end
-
-    def self.find(username)
-      data = UserService.retrieve(username)
-      return nil if data.nil?
-      User.new(data.merge( username: username ))
-    end
-
-    def datasources
-      DatasourceService.retrieve(username).to_collection_with_finders
-    end
-
-    def primary_key
-      username
-    end
-  end
-end

data/lib/ubidots/user_service.rb

@@ -1,9 +0,0 @@
-module Ubidots
-  class UserService
-    def self.retrieve(username)
-      url = "#{Constants::API_URL}/users/#{username}/"
-      response = RestClient.get url, { "X-UbidotsApiKey" => @@key }
-      JSON.parse(response.body)
-    end
-  end
-end

data/lib/ubidots/variable_service.rb

@@ -1,15 +0,0 @@
-module Ubidots
-  class VariableService
-    def self.retrieve_from_datasource(source)
-      url = "#{Ubidots::API_URL}/datasources/#{source.primary_key}/variables/"
-      response = RestClient.get url, { "X-UbidotsApiKey" => @@key }
-      JSON.parse(response.body).to_collection_with_finders
-    end
-
-    def self.retrieve_for_current_user
-      url = "#{Ubidots::API_URL}/variables/"
-      response = RestClient.get url, { "X-UbidotsApiKey" => @@key }
-      JSON.parse(response.body).to_collection_with_finders
-    end
-  end
-end