ubidots 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f9139ab686fb7dc1cafcf9425c0f669c4e07925
+  data.tar.gz: 6581b65a533950e99809d8358ade91e8148de489
+SHA512:
+  metadata.gz: faad8b8591445655428b583e7e3facbb13393c1a9633cc4a255c281fa59849aaaf80498f41a70912ffb9b544a2ca08160bb022a82330fb335f6bad508ea3ddd4
+  data.tar.gz: 0dfcafe5c4f5c15bc7fb5ee27c8707312cb44f1ba1d2c691a673f60aa358234219728f0bc0268d34b92918de161ac551614e8f855f6df370c15bce24d7cc6aba

data/.gitignore

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

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3@ubidots

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Federico Builes
+
+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/README.md

@@ -0,0 +1,86 @@
+# 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/Rakefile

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

data/lib/ubidots.rb

@@ -0,0 +1,90 @@
+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"
+
+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)
+      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'
+      raw_items = response["results"]
+      return transform_to_datasource_objects raw_items
+    end
+
+    def get_variables
+      response = get 'variables'
+      raw_items = response["results"]
+      return transform_to_variable_objects raw_items
+    end
+
+    protected
+
+    def invalid?
+      !defined?(@@token) || !defined?(@@key)
+    end
+
+  end
+
+end

data/lib/ubidots/constants.rb

@@ -0,0 +1,5 @@
+module Ubidots
+  module Constants
+    API_URL = "http://things.ubidots.com/api/v1.6/"
+  end
+end

data/lib/ubidots/datasource.rb

@@ -0,0 +1,39 @@
+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)
+      @id = data["id"]
+      @name = data["name"]
+      @url = data["url"]
+      @last_activity = data["last_activity"]
+      @tags = data["tags"]
+      @description = data["description"]
+      @created_at = data["created_at"]
+      @owner = data["owner"]
+      @parent = data["parent"]
+      @context = data["context"]
+      @variables_url = data["variables_url"]
+      @number_of_variables = data["number_of_variables"]
+    end
+
+    def get_variables
+      endpoint = "datasources/#{@id}/variables"
+      response = Ubidots::ApiClient::get endpoint
+      raw_items = response["results"]
+      return Ubidots::ApiClient::transform_to_variable_objects raw_items
+    end
+    
+
+    def variables
+      VariableService.retrieve_for_datasource(self)
+    end
+
+    def primary_key
+      name
+    end
+  end
+end

data/lib/ubidots/datasource_service.rb

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,9 @@
+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/util/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def to_collection_with_finders
+    CollectionWithFinders.new(self)
+  end
+end

data/lib/ubidots/util/collection_with_finders.rb

@@ -0,0 +1,5 @@
+class CollectionWithFinders < Array
+  def find(id)
+    self.find_all { |item| item.send(:primary_key) == id }.first
+  end
+end

data/lib/ubidots/variable.rb

@@ -0,0 +1,27 @@
+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)
+			@id = data["id"]
+			@name = data["name"]
+			@url = data["url"]
+			@last_activity = data["last_activity"]
+			@tags = data["tags"]
+			@description = data["description"]
+			@created_at = data["created_at"]
+			@icon = data["icon"]
+			@unit = data["unit"]
+			@raw_datasource = data["datasource"]
+			@properties = data["properties"]
+			@values_url = data["values_url"]
+			@last_value = data["last_value"]
+		end
+
+	end
+
+end

data/lib/ubidots/variable_service.rb

@@ -0,0 +1,15 @@
+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

data/lib/ubidots/version.rb

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

data/spec/collection_with_finders_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CollectionWithFinders do
+  describe "#initialize" do
+    it "it's enumerable" do
+      arr = [3, 2, 1]
+      collection = CollectionWithFinders.new(arr)
+      collection.sort.should == [1, 2, 3]
+    end
+  end
+
+  describe "#find" do
+    it "finds the record by providing the primary key" do
+      arr = ["foo", "ohnoes", "nowai"].to_collection_with_finders
+      arr.find(3).should == "foo"
+    end
+  end
+end

data/spec/datasource_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Ubidots::Datasource do
+  describe "#variables" do
+    it "returns a list of variables" do
+      source = Ubidots::Datasource.new
+      Ubidots::VariableService.stub(:retrieve_for_datasource).and_return([1, 2, 3])
+      source.variables.should == [1, 2, 3]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/ubidots'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+@@key = "test"
+@@token = "test"
+
+# useful for testing any cases of CollectionWithFinders
+class String
+  def primary_key
+    length
+  end
+end

data/spec/ubidots_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Ubidots do
+  describe ".datasources" do
+    it "returns a list of data sources" do
+      Ubidots::DatasourceService.stub(:retrieve_without_username).and_return([1, 2, 3])
+      Ubidots.datasources.should == [1, 2, 3]
+    end
+
+    it "returns a collection with finders" do
+      expected = ["foo", "baaar"].to_collection_with_finders
+      Ubidots::DatasourceService.stub(:retrieve_without_username).and_return(expected)
+      Ubidots.datasources.find(3).should == "foo"
+    end
+  end
+
+  describe ".variables" do
+    it "returns a collection with finders" do
+      expected = ["foo", "baaar"].to_collection_with_finders
+      Ubidots::VariableService.stub(:retrieve_for_current_user).and_return(expected)
+      Ubidots.variables.find(3)
+    end
+  end
+end

data/spec/user_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Ubidots::User do
+  let(:params) { { followers: 11, following: 12 } }
+
+  before do
+    Ubidots::UserService.stub(:retrieve).and_return(params)
+    Ubidots::DatasourceService.stub(:retrieve).and_return([1, 2, 3])
+  end
+
+  describe ".initialize" do
+    it "automatically initializes all the object params" do
+      user = Ubidots::User.new(params)
+      user.followers.should == 11
+      user.following.should == 12
+    end
+  end
+
+  describe ".find" do
+    it "finds a user through the API" do
+      user = Ubidots::User.find("federico")
+      user.following.should == 12
+      user.username.should == "federico"
+    end
+
+    it "returns nil if no user is found" do
+      Ubidots::UserService.should_receive(:retrieve).with("federico").and_return(nil)
+      user = Ubidots::User.find("federico")
+      user.should be_nil
+    end
+  end
+
+  describe "#datasources" do
+    it "returns the datasources for a given user" do
+      user = Ubidots::User.find("federico")
+      user.datasources.should == [1, 2 , 3]
+    end
+  end
+
+  describe "#profile" do
+    it "returns the user's profile" do
+      user = Ubidots::User.find("federico")
+      user.profile.should == params.merge(username: "federico")
+    end
+  end
+end

data/ubidots.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = "Ruby library to access the Ubidots API"
+  gem.homepage      = ""
+
+  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")
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ubidots
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Federico Builes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-23 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  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
+email:
+- federico.builes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- Gemfile
+- LICENSE.txt
+- README.md
+- 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/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
+- spec/spec_helper.rb
+- spec/ubidots_spec.rb
+- spec/user_spec.rb
+- ubidots.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby library to access the Ubidots API
+test_files:
+- spec/collection_with_finders_spec.rb
+- spec/datasource_spec.rb
+- spec/spec_helper.rb
+- spec/ubidots_spec.rb
+- spec/user_spec.rb