cs 0.1.0beta3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9c07ce0761efba489c25ac1286348c278d43024
+  data.tar.gz: a200d01e595e45f19d4188a68b3089ab864222f0
+SHA512:
+  metadata.gz: ee82e700560960c985a55829cba9987952b619b20395435d111948695f36550e9c3f4d5ea6d2bc1a4ae784c78dacdba6c3fb710c4268affcc80782e364b2fcce
+  data.tar.gz: 32cbaac901131587917bc9a9ada98678399cab0d34bec5ba83cd50daee54f13c08377c7879b82ffb7a39bd659dea8b2861b19424bb4fcfdc8d0dd63a25d9e7a5

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-2.2.1
+  - jruby-head
+script: bundle exec rspec spec

data/Gemfile

@@ -1,10 +1,26 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in commonsense-ruby-lib.gemspec
+# Specify your gem's dependencies in cs.gemspec
 gemspec
-gem "pry"
-gem "pry-nav"
-gem "pry-doc"
-gem "redcarpet"
 gem "time-lord"
-#gem "pry-stack_explorer"
+gem 'json'
+
+#
+# Rubinius does not load ruby stdlib by default
+#
+
+platforms :rbx do
+  gem 'rubysl'
+end
+
+group :test do
+  gem "rake", "~> 10.1.0"
+  gem "webmock", "~> 1.13.0"
+  gem "rspec", "~> 2.14.1"
+end
+
+group :development do
+  gem "pry"
+  gem "pry-nav"
+  gem "pry-doc"
+end

data/README.md

@@ -1,11 +1,14 @@
 # Commonsense::Ruby::Lib
 Client library to communicate with CommonSense written in ruby
 
+[![Code Climate](https://codeclimate.com/github/senseobservationsystems/commonsense-ruby-lib.png)](https://codeclimate.com/github/senseobservationsystems/commonsense-ruby-lib)
+[![Build Status](https://travis-ci.org/senseobservationsystems/commonsense-ruby-lib.png?branch=master)](https://travis-ci.org/senseobservationsystems/commonsense-ruby-lib)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'commonsense-ruby-lib'
+    gem 'cs'
 
 And then execute:
 
@@ -13,15 +16,20 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install commonsense-ruby-lib
+    $ gem install cs
 
 ## Usage
 
 ### Authentication
 ```ruby
-client = CommonSense::Client.new
+client = CS::Client.new
 client.login('username','password')
 
+# setting session_id manually
+
+client = CS::Client.new
+client.session_id = '1234'
+
 # get current user
 current_user = client.current_user
 ```
@@ -32,13 +40,16 @@ current_user = client.current_user
 sensors = client.sensors
 
 # is the same as
-sensors = CommonSense::Relation::Sensors.new
+sensors = CS::Relation::Sensors.new
 sensors.session = session
 
 # Get all sensor
 sensors = client.sensors
 sensors.to_a
 
+# show parameters available when querying
+client.sensors.parameters
+
 # Get sensor by specifying parameters
 client.sensors.where(page: 0, per_page: 1000)
 client.sensors.where(owned: true)

data/cs.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/commonsense-ruby-lib/version', __FILE__)
+require File.expand_path('../lib/cs/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Ahmy Yulrizka"]
@@ -8,15 +8,15 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Client library to communicate with CommonSense written in ruby}
   gem.homepage      = "https://github.com/senseobservationsystems/commonsense-ruby-lib"
 
+  gem.required_ruby_version = '>= 1.9.3'
+
   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.name          = "cs"
   gem.require_paths = ["lib"]
-  gem.version       = CommonSense::VERSION
-  gem.add_development_dependency("rspec", "~> 2.13.0")
-  gem.add_development_dependency("launchy", "~> 2.3.0")
-  gem.add_development_dependency("fakeweb", "~> 1.3.0")
-  gem.add_dependency('httparty', '~> 0.11.0')
-  gem.add_dependency('oauth', '~> 0.4.7')
+  gem.version       = CS::VERSION
+  gem.add_development_dependency("launchy", "~> 2.3")
+  gem.add_dependency('httparty', '~> 0.12')
+  gem.add_dependency('oauth', '~> 0.4')
 end

data/lib/{commonsense-ruby-lib.rb → cs.rb}

@@ -1,18 +1,27 @@
-require "commonsense-ruby-lib/version"
-require "commonsense-ruby-lib/error"
-require "commonsense-ruby-lib/auth/http"
-require "commonsense-ruby-lib/auth/oauth"
-require "commonsense-ruby-lib/session"
-require "commonsense-ruby-lib/end_point"
-require "commonsense-ruby-lib/end_point/user"
-require "commonsense-ruby-lib/end_point/group"
-require "commonsense-ruby-lib/end_point/sensor"
-require "commonsense-ruby-lib/end_point/sensor_data"
-require "commonsense-ruby-lib/relation"
-require "commonsense-ruby-lib/relation/sensor_relation"
-require "commonsense-ruby-lib/relation/sensor_data_relation"
-
-module CommonSense
+require "cs/version"
+require "cs/error"
+require "cs/time"
+require "cs/auth/http"
+require "cs/auth/oauth"
+require "cs/session"
+require "cs/end_point"
+require "cs/end_point/user"
+require "cs/end_point/group"
+require "cs/end_point/sensor"
+require "cs/end_point/sensor_data"
+require "cs/end_point/trigger"
+require "cs/end_point/notification"
+require "cs/parameter_processor"
+require "cs/relation"
+require "cs/relation/sensor_relation"
+require "cs/relation/sensor_data_relation"
+require "cs/relation/user_relation"
+require "cs/relation/group_relation"
+require "cs/relation/trigger_relation"
+require "cs/relation/notification_relation"
+require "cs/collection/sensor_data_collection"
+
+module CS
 
   # Main entry class of the library.
   #
@@ -20,28 +29,29 @@ module CommonSense
   # will raise an exception when there is an error and the normal (without !)
   # will return nil when it fails.
   #
-  # The response can be viewed by looking at the {CommonSense::Session}
+  # The response can be viewed by looking at the {CS::Session}
   #
   #     client.session # will return the session object
   #
   # == Authentication with User And Password
   #
-  #     client = CommonSense::Client.new
+  #     client = CS::Client.new
   #     client.login('username', 'password')
   #
   # == Authentication using OAuth
   #
-  #     client = CommonSense::Client.new
+  #     client = CS::Client.new
   #     client.oauth('CONSUMER_KEY', 'CONSUMER_SECRET', 'ACCESS_TOKEN', 'ACCESS_TOKEN_SECRET')
   #
   # == Using different API server
   #
-  #     client = CommonSense::Client.new(base_uri: 'https://api.dev.sense-os.nl')
+  #     client = CS::Client.new(base_uri: 'https://api.dev.sense-os.nl')
   #     # or
   #     client.base_uri = 'https://api.dev.sense-os.nl'
   #
   class Client
     attr_accessor :session, :base_uri
+    attr_reader :logger
 
     def initialize(opts={})
       options = {
@@ -50,43 +60,61 @@ module CommonSense
       @base_uri = options[:base_uri]
     end
 
+    def logger=(logger)
+      @logger = logger
+      @session.logger = logger if @session
+    end
+
     # Create a new session to CommonSense using username and plain text password
     # with `login!` it will throw exception if there is an error
     #
-    #    client = CommonSense::Client.new
+    #    client = CS::Client.new
     #    client.login!('username', 'password')
-    def login!(user, password)
+    def login!(user, password, digest=true)
       @session = Session.new(base_uri: @base_uri)
-      @session.login(user, password)
+      @session.logger = logger
+      @session.login(user, password, digest)
     end
 
     # Create a new session to CommonSense using username and plain text password
     # with `login` it will return nil if it not successful
     #
-    #    client = CommonSense::Client.new
+    #    client = CS::Client.new
     #    client.login('username', 'password')
-    def login(user, password)
-      login!(user, password) rescue nil
+    def login(user, password, digest=true)
+      login!(user, password, digest) rescue false
     end
 
     # Create a new session to CommonSense using OAuth credentials
     #
-    #    client = CommonSense::Client.new
+    #    client = CS::Client.new
     #    client.login('username', 'password')
     def oauth(consumer_key, consumer_secret, access_token, access_token_secret)
       @session = Session.new(base_uri: @base_uri)
+      @session.logger = logger
       @session.oauth(consumer_key, consumer_secret, access_token, access_token_secret)
     end
 
     # Create new session by manually specifiying `session_id` parameter
     #
-    #     client = CommonSense::Client.new
-    #     client.session_id('12345')
-    def set_session_id(session_id)
+    #     client = CS::Client.new
+    #     client.session_id = '12345'
+    def session_id=(session_id)
       @session = Session.new(base_uri: @base_uri)
+      @session.logger = logger
       @session.session_id = session_id
     end
 
+    # Create new session by specifying api_key
+    #
+    #     client = CS::Client.new
+    #     client.session_id = '12345'
+    def api_key=(api_key)
+      @session = Session.new(base_uri: @base_uri)
+      @session.logger = logger
+      @session.api_key = api_key
+    end
+
     # Retrun logged in user
     def current_user
       user = EndPoint::User.new
@@ -96,7 +124,7 @@ module CommonSense
 
     # Create a new user
     #
-    #     client = CommonSense::Client.new
+    #     client = CS::Client.new
     #     client.new_user(username: 'Ahmy')
     #     client.email = 'ahmy@gmail.com'
     #     ...
@@ -107,21 +135,42 @@ module CommonSense
      user
     end
 
-    # @see CommonSense::Relation::SensorRelation
+    def users
+      Relation::UserRelation.new(@session)
+    end
+
+    # @see CS::Relation::SensorRelation
     def sensors
       Relation::SensorRelation.new(@session)
     end
 
+    def groups
+      Relation::GroupRelation.new(@session)
+    end
+
+    def triggers
+      Relation::TriggerRelation.new(@session)
+    end
+
+    def notifications
+      Relation::NotificationRelation.new(@session)
+    end
+
     def current_groups
       group = EndPoint::Group.new
       group.session = @session
       group.current_groups
     end
 
+
     # return errors got from session
     def errors
       return @session.errors if @session
     end
   end
+
+  def self.load_CLI
+    require "cs/cli/cli"
+  end
 end
 

data/lib/{commonsense-ruby-lib → cs}/auth/http.rb

@@ -1,59 +1,75 @@
 require "httparty"
 require "json"
 
-module CommonSense
+module CS
   module Auth
     class HTTP
       include HTTParty
 
       attr_accessor :response_body, :response_code, :response_headers, :errors
-      attr_reader :session_id
+      attr_reader :session_id, :api_key
 
-      def initialize(base_uri = nil)
+      def initialize(base_uri = nil, api_key = nil)
         self.base_uri = base_uri
+        @api_key = api_key
         @session_id = nil
         reset
       end
 
-      def get(path, query={}, headers = {})
+      def execute(&block)
         reset
-        headers = default_headers.merge(headers)
-        options = {query: query, headers: headers} 
-        @response_body = self.class.get(path, options)
+        @response_body = yield
         parse_response
         @response_body
       end
 
+      def process_api_key(path)
+        return path if @api_key.nil?
+
+        if URI(path).query.nil?
+          path += "?API_KEY=#{@api_key}"
+        else
+          path += "&API_KEY=#{@api_key}"
+        end
+
+        path
+      end
+
+      def get(path, query={}, headers = {})
+        execute do
+          headers = default_headers.merge(headers)
+          options = {query: query, headers: headers}
+          path = process_api_key(path)
+          self.class.get(path, options)
+        end
+      end
+
       def post(path, body = '', headers = {})
-        reset
-        headers = default_headers.merge(headers)
-        @response_body = self.class.post(path, prepare(body, headers))
-        parse_response
-        @response_body
+        execute do
+          headers = default_headers.merge(headers)
+          self.class.post(path, prepare(body, headers))
+        end
       end
 
       def put(path, body = '', headers = {})
-        reset
-        headers = default_headers.merge(headers)
-        @response_body = self.class.put(path, prepare(body, headers))
-        parse_response
-        @response_body
+        execute do
+          headers = default_headers.merge(headers)
+          self.class.put(path, prepare(body, headers))
+        end
       end
 
       def delete(path, query={}, headers = {})
-        reset
-        headers = default_headers.merge(headers)
-        options = {query: query, headers: headers} 
-        @response_body = self.class.delete(path, options)
-        parse_response
-        @response_body
+        execute do
+          headers = default_headers.merge(headers)
+          options = {query: query, headers: headers}
+          self.class.delete(path, options)
+        end
       end
 
       def head(path, headers = {})
-        reset
-        @response_body = self.class.head(path, prepare(nil, headers))
-        parse_response
-        @response_body
+        execute do
+          self.class.head(path, prepare(nil, headers))
+        end
       end
 
       def base_uri=(uri = nil)
@@ -62,9 +78,9 @@ module CommonSense
 
       def default_headers
         header = self.class.default_options[:headers] || {}
-        header.merge({"Content-Type" => "application/json"})
+        header.merge!({"Content-Type" => "application/json"})
         if @session_id
-          header.merge!('X-SESSION_ID' => self.session_id)
+          header = header.merge('X-SESSION_ID' => self.session_id)
         end
         header
       end
@@ -77,17 +93,19 @@ module CommonSense
         @session_id = session_id
       end
 
-
       # login to commonsense
       # @return [String] session_id
-      def login(username, password)
-        password = Digest::MD5.hexdigest password
+      def login(username, password, digest=true)
+        if digest
+          password = Digest::MD5.hexdigest password
+        end
         post('/login.json', {:username => username, :password => password})
 
         if @response_code == 200
           self.session_id = response_body['session_id']
         else
-          errors = [response_body['error']]
+          self.session_id = false
+          @errors = [response_body['error']]
         end
 
         session_id
@@ -101,6 +119,7 @@ module CommonSense
       end
 
       def parse_response
+        return unless @response_body
         @response_code = @response_body.response.code.to_i
         @response_headers = @response_body.headers
         if @response_code >= 400