sensr 1.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/History.txt

@@ -0,0 +1,4 @@
+=== 3.0.0 2012-12-15
+
+1 major enhancement:
+  * Initial Release

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/sensr/api_error.rb

@@ -0,0 +1,5 @@
+module Sensr
+  class APIError < StandardError
+
+  end
+end

data/lib/sensr/camera.rb

@@ -0,0 +1,112 @@
+module Sensr
+  class Camera < SensrObject
+    # Find a camera by id. Only cameras owned by the current user and public cameras will be returned.
+    # ==== Attributes
+    # * +id+ The id of the camera to return
+    def self.find(id)
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + id.to_s, nil)
+      Camera.new(response)
+    end
+
+    # Get an array of cameras owned by the current user.
+    def self.owned
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/owned' , nil)
+      cameras = response["cameras"].collect { |c| Camera.new(c) }
+      cameras
+    end
+
+    # Get an array of cameras shared with the current user.
+    def self.shared
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/shared' , nil)
+      cameras = response["cameras"].collect { |c| Camera.new(c) }
+      cameras
+    end
+
+    # Create a new camera from a hash of attributes. The attributes "name", "sens", and "model" may be set.
+    def self.create(atts)
+      response = Sensr.request(:post, Sensr.api_base_url + '/cameras/create' , nil, atts)
+      Camera.new(response)
+    end
+    
+    # Save any changed parameters to the camera. 
+    def save
+      response = Sensr.request(:post, Sensr.api_base_url + '/cameras/update' , nil, self.attributes)
+      new_cam = response["camera"]
+      new_cam["urls"] = response["urls"]
+      self.attributes = new_cam
+    end
+
+    # Delete the camera
+    def destroy
+      response = Sensr.request(:delete, Sensr.api_base_url + '/cameras/' + self.attributes["id"].to_s , nil)
+    end
+
+    # Convert an epoch time to a date in the camera's timezone.
+    # ==== Attributes
+    # * +epoch_time+ A unix timestamp
+    def localtime(epoch_time)
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/localtime/" + epoch_time.to_s , nil)
+    end
+
+    # Get the camera's latest image
+    def latest
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/latest" , nil)
+    end
+
+    # Send a zoom in request to the camera
+    def zoomin
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/zoomin" , nil)
+    end
+
+    # Send a zoom out request to the camera
+    def zoomout
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/zoomout" , nil)
+    end
+
+    # Turn the camera's led on
+    def ledon
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/ledon" , nil)
+    end
+
+    # Turn the camera's led off
+    def ledoff
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/ledoff" , nil)
+    end
+
+    # Get a summary of the day specified by epoch_time. If no time is provided, return the last day which has data.
+    # ==== Attributes 
+    # * +epoch_time+ A unix timestamp
+    def day(epoch_time = "")
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/day/" + epoch_time.to_s , nil)
+    end
+
+    # Get a summary of the hour specified by epoch_time. If no time is provided, return the last hour which has data.
+    # ==== Attributes 
+    # * +epoch_time+ A unix timestamp
+    def hour(epoch_time = "")
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/hour/" + epoch_time.to_s , nil)
+    end
+
+    # Get a summary of the week specified by epoch_time. If no time is provided, return the last week which has data.
+    # ==== Attributes 
+    # * +epoch_time+ A unix timestamp
+    def week(epoch_time = "")
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/week/" + epoch_time.to_s , nil)
+    end
+
+    # Get a summary of the month specified by epoch_time. If no time is provided, return the last month which has data.
+    # ==== Attributes 
+    # * +epoch_time+ A unix timestamp
+    def month(epoch_time = "")
+      response = Sensr.request(:get, Sensr.api_base_url + '/cameras/' + self.id.to_s + "/month/" + epoch_time.to_s , nil)
+    end
+
+    # Create a new camera object from the attribute hash returned by a camera API call.
+    def initialize(hash) # :nodoc:
+      new_hash = hash["camera"]
+      new_hash["urls"] = hash["urls"]
+      super(new_hash)
+    end
+
+  end
+end

data/lib/sensr/clip.rb

@@ -0,0 +1,13 @@
+module Sensr
+  class Clip < SensrObject
+
+    def initialize(id, hash)
+      super(hash)
+    end
+    
+    def self.public
+      response = Sensr.request(:get, Sensr.api_base_url + '/clips/public.json', nil)
+      Clip.new(response)
+    end
+  end
+end

data/lib/sensr/device.rb

@@ -0,0 +1,28 @@
+module Sensr
+  class Device < SensrObject
+
+    def initialize(id, hash) # :nodoc:
+      new_hash = hash["device"]
+      new_hash["id"] = id if new_hash && new_hash.size > 0 && new_hash["id"].nil?
+      super(new_hash)
+    end
+
+    # Find a device by id
+    # ==== Attributes
+    # * +id+ id of the device to be returned
+    def self.find(id)
+      response = Sensr.request(:get, Sensr.api_base_url + '/devices/' + id.to_s, nil)
+      Device.new(id, response)
+    end
+
+    # Save any updated device attributes
+    def save
+      response = Sensr.request(:put, 
+                               Sensr.api_base_url + '/devices/' + self.attributes["id"].to_s, 
+                               nil, 
+                               self.attributes)
+      self.attributes = response["device"]
+    end
+
+  end
+end

data/lib/sensr/plan.rb

@@ -0,0 +1,15 @@
+module Sensr
+  class Plan < SensrObject
+
+    def initialize(hash) # :nodoc:
+      super(hash)
+    end
+    
+    # Get the current user's plan
+    def self.current
+      response = Sensr.request(:get, Sensr.api_base_url + '/plans/current', nil)
+      Plan.new(response)
+    end
+
+  end
+end

data/lib/sensr/sensr_object.rb

@@ -0,0 +1,28 @@
+module Sensr
+  class SensrObject # :nodoc:
+    
+    def initialize(hash)
+      self.attributes = hash
+    end
+
+    def attributes
+      @hash.clone
+    end
+
+    def attributes=(hash)
+      @hash = hash.clone
+    end
+
+    def method_missing(name, *args)
+      return @hash[name.to_s] if @hash.key?(name.to_s)
+      if name.to_s =~ /(.*)=$/
+        att_name = $1
+        @hash[att_name] = args.first
+        return
+      end
+      super.method_missing(name)
+    end
+
+    
+  end
+end

data/lib/sensr/user.rb

@@ -0,0 +1,17 @@
+module Sensr
+  class User < SensrObject
+    # Get the current user 
+    def self.me
+      response = Sensr.request(:get, Sensr.api_base_url + '/users/me', nil)
+      User.new(response)
+    end
+
+    
+    def initialize(hash) # :nodoc:
+      new_hash = hash["user"]
+      new_hash["urls"] = hash["urls"]
+      super(new_hash)
+    end
+
+  end
+end

data/lib/sensr/version.rb

@@ -0,0 +1,3 @@
+module Sensr
+  VERSION = '1.0.0'
+end

data/lib/sensr.rb

@@ -0,0 +1,148 @@
+require 'rubygems'
+require 'cgi'
+require 'openssl'
+
+gem 'rest-client', '~> 1.4'
+require 'rest_client'
+require 'multi_json'
+
+require 'sensr/version'
+require 'sensr/sensr_object'
+require 'sensr/camera'
+require 'sensr/user'
+require 'sensr/device'
+require 'sensr/clip'
+require 'sensr/plan'
+require 'sensr/api_error'
+
+module Sensr
+
+  @@api_base_url = "https://api.sensr.net/u/v3"
+  @@oauth_token = nil
+
+  # Set the oauth token to be used for future API calls
+  # 
+  # ==== Attributes
+  # * +token+ A valid sensr oauth token
+  def self.oauth_token=(token)
+    @@oauth_token = token
+  end
+
+  # Get the oauth token previously assigned
+  def self.oauth_token
+    @@oauth_token
+  end
+
+  # Return the base url for API queries
+  def self.api_base_url
+    @@api_base_url
+  end
+
+  # Set the client ID to be used for API queries
+  # ==== Attributes
+  # * +id+ A valid sensr API client ID
+  def self.client_id=(id)
+    @@client_id = id
+  end
+
+  # Return the client ID previously assigned
+  def self.client_id
+    @@client_id
+  end
+
+  # Set the client secret to be used for API queries
+  # ==== Attributes
+  # * +secret+ The client secret associated with the current client ID
+  def self.client_secret=(secret)
+    @@client_secret = secret
+  end
+
+  # Return the client secret previously assigned
+  def self.client_secret
+    @@client_secret
+  end
+
+  # Fetch the oauth token for a specific user, using previously assigned client id and secret. 
+  # Also assigns the oauth_token to be used for all future API queries.
+  # ==== Attributes
+  # * +username+ Username
+  # * +password+ Password
+  def self.oauth_token_for_user(username, password)
+    params = {
+      "grant_type" => "password",
+      "client_id" => self.client_id,
+      "client_secret" => self.client_secret,
+      "scope" => "user read write",
+      "username" => username,
+      "password" => password
+    }
+    response = Sensr.request(:post, "https://api.sensr.net/oauth/access_token", nil, params)
+    self.oauth_token = response["access_token"]
+  end
+
+  # Makes a request to the Sensr API
+  # ==== Attributes
+  # * +method+ http method to be used e.g. :get,:post,:put,:delete
+  # * +url+ the url to request
+  # * +oauth_token+ a valid sensr oauth token to be used for the request
+  # * +params+ the parameters to be passed in the request body, for puts/posts
+  # * +headers+ the http headers to set by default
+  def self.request(method, url, oauth_token, params={}, headers={})
+    oauth_token ||= self.oauth_token
+    payload = nil
+    if params && params.size > 0
+      if [:put, :post].index(method.to_s.downcase.to_sym)
+        payload = params.collect{|key, value| "#{key.to_s}=#{CGI::escape(value.to_s)}"}.join("&")
+      end
+    end
+
+    request_headers = {
+      :content_type => "application/x-www-form-urlencoded"
+    }.merge(headers)
+
+    request_headers[:authorization] = "OAuth " + oauth_token.to_s if oauth_token
+
+    opts = {
+      :method => method,
+      :url => url,
+      :headers => request_headers,
+      :timeout => 120,
+      :payload => payload
+    }
+
+    begin 
+      response = RestClient::Request.execute(opts)
+      return MultiJson.load(response.body)
+    rescue RestClient::ExceptionWithResponse => e
+      handle_api_error(e)
+    rescue RestClient::Exception => e
+      raise APIError.new(e.message)
+    rescue MultiJson::DecodeError
+      raise APIError.new("Invalid JSON returned by API (#{response.code}: #{response.body.inspect})", response.code, response.body)
+    end
+  end
+
+  def self.handle_api_error(e)
+    case e.http_code
+    when 400 then
+      raise APIError.new("Bad request: " + e.http_body.to_s)
+    when 401
+      raise APIError.new("Access denied: " + e.http_body.to_s)
+    when 404 
+      raise APIError.new("Resource not found: " + e.http_body.to_s)
+    end
+
+    begin
+      json = MultiJson.load(e.http_body)
+    rescue MultiJson::DecodeError
+      raise APIError.new("Invalid JSON returned by API (#{e.http_code}: #{e.http_body.inspect})", response.code, response.body)
+    end
+
+    if json["error"].to_s.strip.size > 0
+      raise APIError.new(json)
+    end
+
+    json
+  end
+
+end

data/sensr.gemspec

@@ -0,0 +1,20 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'sensr/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'sensr'
+  s.version = Sensr::VERSION
+  s.summary = 'Ruby bindings for the Sensr API'
+  s.description = 'Sensr: Watch Your Stuff.'
+  s.authors = ['Sensr Net, Inc']
+  s.email = ['info@sensr.net']
+  s.homepage = 'https://api.sensr.net'
+  s.require_paths = %w{lib}
+
+  s.add_dependency('rest-client', '~> 1.4')
+  s.add_dependency('multi_json', '>= 1.0.4', '< 2')
+
+  s.files = ["Gemfile", "History.txt", "sensr.gemspec", "VERSION", "lib/sensr.rb", "lib/sensr/user.rb", "lib/sensr/version.rb", "lib/sensr/device.rb", "lib/sensr/sensr_object.rb", "lib/sensr/plan.rb", "lib/sensr/clip.rb", "lib/sensr/camera.rb", "lib/sensr/api_error.rb"]
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: sensr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Sensr Net, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+description: ! 'Sensr: Watch Your Stuff.'
+email:
+- info@sensr.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- History.txt
+- sensr.gemspec
+- VERSION
+- lib/sensr.rb
+- lib/sensr/user.rb
+- lib/sensr/version.rb
+- lib/sensr/device.rb
+- lib/sensr/sensr_object.rb
+- lib/sensr/plan.rb
+- lib/sensr/clip.rb
+- lib/sensr/camera.rb
+- lib/sensr/api_error.rb
+homepage: https://api.sensr.net
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for the Sensr API
+test_files: []