cs 0.1.1beta → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da893437e3bafdedfc45e0ee607d2bf923faa73c
-  data.tar.gz: 4c63a68ad28063ce2a61968ec71da47c7e41fb94
+  metadata.gz: 3c833d41fcb9aa813c7aeda87ad3aac228ace39d
+  data.tar.gz: 0e73999b1157e0641241a7fbf1ddb985416e16df
 SHA512:
-  metadata.gz: 2ab95c33150cc511f53a057280e83fe35eafcdd61b48acab6ef6bce312511af17c295945e06412b36c98446fc012c60df6aebd7e03017a8cc275e866461bdd36
-  data.tar.gz: 3973ad261722529b962970e5c956eb921045820cde9ccff0d268824024ffa3cddd487a9bca7faa56f1430320bbd93c8ac45453af135371aa70e1cead6debbd0a
+  metadata.gz: b2397a73ae5ba94dab965f2d47a2e4f00d26611fbf1e382761a9488527c105e9c904ae053f4aea8815ba85c0563f3ff5bc2d047da9909ee2145cf93eabc6c093
+  data.tar.gz: 53f83903a01000f4690768f40bdc321340071147559d33126cdd6a1ee1f7ca4ac04fdd1c919ab0cd0f941989e79c38f4237a08a105f8dead596eb2ae88fc9f28

data/.travis.yml

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

data/Gemfile

@@ -3,7 +3,15 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in cs.gemspec
 gemspec
 gem "time-lord"
-gem 'json', '~> 1.7.7'
+gem 'json'
+
+#
+# Rubinius does not load ruby stdlib by default
+#
+
+platforms :rbx do
+  gem 'rubysl'
+end
 
 group :test do
   gem "rake", "~> 10.1.0"

data/README.md

@@ -129,6 +129,80 @@ session.dump_to_text("/tmp/output.txt")
 session.open_in_browser
 ```
 
+## Command Line Executable
+
+This gem also contain executables to run from command line. The main executable is `cs`
+
+```bash
+$ cs -h
+Usage: cs <command>
+
+    -h, --help                       Show this message
+
+Available commands are:
+
+    console       Run REPL console based on PRY
+    password      Generate hased password from plaintext
+
+```
+
+The console executable will run an REPL (Read Evaluate Print Loop) session based on pry.
+
+install `pry` first in order to use it. `pry-doc` and `pry-nav` is optional
+
+```bash
+$ gem install pry
+$ gem install pry-doc
+$ gem install pry-nav
+```
+
+you can have a configuration file on `~/.cs.yml` which contain the following
+
+```yaml
+users:
+  user1:
+    username: "user1@example.com"
+    password: ""
+    password_md5: 1234567890abcdef1234567890abcdef
+  user2:
+    username: "user2@example.com"
+    password: "V3rryS3curePaswd"
+    password_md5: ""
+
+default_user: user1
+```
+
+you can either fill in the password or md5-hashed password. It will use `password_md5` if you fill in both
+
+
+now you can use it on cs console
+
+```bash
+$ cs console
+CS console 0.1.1
+
+# create a client with default user
+
+[1] pry(main)> client = new_client()
+Successfully logged in with user 'user1@example.com'
+=> #<CS::Client:0x00000004cd7540
+ @base_uri="https://api.sense-os.nl",
+ @session=SESSION_ID "1234567890abcdefg1.23456789">
+
+# create a client with another user
+
+[2] pry(main)> user2_client = new_client("user2")
+Successfully logged in with user 'user2@example.com'
+=> #<CS::Client:0x00000004cd7560
+ @base_uri="https://api.sense-os.nl",
+ @session=SESSION_ID "1234567890abcdefg1.23456789">
+
+# create an empty client object and will not do the login
+
+[3] pry(main)> empty_client = new_client(false)
+> #<CS::Client:0x00000004cf2cf0 @base_uri="https://api.sense-os.nl">
+```
+
 ## Testing
 
     $ cp spec/support/spec_config.yml.sample spec/support/spec_config.yml

data/bin/cs

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+# (C) Ahmy Yulrizka (ahmy@sense-os.nl)
+
+require 'optparse'
+
+options = {password: '', double: false}
+
+def print_help
+<<EOL
+
+Available commands are:
+
+    console       Run REPL console based on PRY
+    password      Generate hased password from plaintext
+
+EOL
+end
+
+def print_error_and_exit(message, code=1)
+	puts "Error: #{message}"
+	exit code
+end
+
+if ARGV.empty?
+	puts "Usage: cs <command>"
+	puts print_help
+	exit 0
+end
+
+current_path = File.dirname(__FILE__)
+
+if ARGV[0].nil? or ARGV[0].empty?
+	print_error_and_exit("Invalid command")
+end
+
+command = ARGV[0]
+executable = "cs-#{command}"
+executable_path = File.join(current_path, executable)
+
+if !File.exists?(executable_path)
+	OptionParser.new do |opts|
+		opts.banner = "Usage: cs <command>"
+
+		opts.separator ""
+		opts.on_tail("-h", "--help", "Show this message") do
+
+			puts opts
+			puts print_help
+			exit
+		end
+	end.parse!
+
+	print_error_and_exit("Invalid command '#{command}'")
+end
+
+arguments = ARGV.slice(1..-1)
+exec(executable_path, *arguments)

data/bin/cs-console

@@ -0,0 +1,154 @@
+#!/usr/bin/env ruby
+
+# (C) Ahmy Yulrizka (ahmy@sense-os.nl)
+
+$0 = 'pry'
+
+begin
+  require 'pry'
+rescue LoadError
+  require 'rubygems'
+  require 'pry'
+end
+
+require 'cs'
+require 'logger'
+require 'optparse'
+require 'digest/md5'
+
+DEBUG = Logger::DEBUG
+ERROR = Logger::ERROR
+FATAL = Logger::FATAL
+INFO = Logger::INFO
+UNKNOWN = Logger::UNKNOWN
+WARN = Logger::WARN
+
+CS::load_CLI
+
+##
+# OPTION Parsing
+##
+OPTIONS = {
+  config_file: "#{ENV['HOME']}/.cs.yml",
+  log_level: INFO
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: cs console [options]"
+
+  opts.on("-c", "--config", "Config file default to #{OPTIONS[:config_file]}") do |v|
+    OPTIONS[:config_file] = v
+  end
+
+  opts.on("-v", "--verbosity <log_level>", "Log verbosity. <log_level> is one of: debug, error, fatal, info, unknown, warns. Default to info") do |v|
+    mapping = {
+      "debug" => DEBUG,
+      "error" => ERROR,
+      "fatal" => FATAL,
+      "info" => INFO,
+      "unknown" => UNKNOWN,
+      "warns" => WARN
+    }
+
+    level = mapping[v.downcase]
+    OPTIONS[:log_level] = level
+  end
+
+  opts.separator ""
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+##
+# Helper Method
+##
+
+STDOUT_LOGGER = Logger.new(STDOUT)
+STDOUT_LOGGER.level = OPTIONS[:log_level]
+
+def print_error(message)
+	STDERR.puts "Error: #{message}"
+end
+
+def config(key=nil)
+  CS::CLI::Config::get(key)
+end
+
+def new_client(user=nil)
+  client = CS::Client.new
+
+  if user == false
+    return client
+  end
+
+  user_creds = nil
+  if user == false
+    return client
+  elsif user == nil # load default user
+    default_user = config["default_user"]
+    user_creds = config["users"][default_user] rescue nil
+  else # load user by reference
+    user_creds = config["users"][user]
+  end
+
+
+  username = user_creds["username"]
+  password = user_creds["password_md5"]
+
+  if password.nil? || password.empty?
+    password = user_creds["password"]
+    password = Digest::MD5.hexdigest(password)
+  end
+
+
+  if client.login!(username, password, false)
+    STDOUT.puts "Successfully logged in with user '#{username}'"
+  else
+    print_error("Failed login with user #{username} -> #{client.session.errors}")
+  end
+
+  client.session.logger = STDOUT_LOGGER
+  client
+end
+
+def set_log_level(level)
+  OPTIONS[:log_level] = level
+  STDOUT_LOGGER.level = level
+end
+
+def const_to_level_log(value)
+  mapping = {
+    DEBUG => "debug",
+    ERROR => "error",
+    FATAL => "fatal",
+    INFO => "info",
+    UNKNOWN => "unknown",
+    WARN => "warns"
+  }
+
+  mapping[value]
+end
+
+def log_level?
+  const_to_level_log(OPTIONS[:log_level])
+end
+
+##
+# MAIN
+##
+
+begin
+  CS::CLI::Config::load_config(OPTIONS[:config_file])
+rescue => e
+  if File.exists?(OPTIONS[:config_file])
+    throw e
+  end
+end
+
+puts "CS console #{CS::VERSION}"
+puts
+
+# Process command line options and run Pry
+Pry::CLI.parse_options

data/bin/cs-password

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+# (C) Ahmy Yulrizka (ahmy@sense-os.nl)
+
+require 'optparse'
+require 'io/console'
+require 'digest/md5'
+
+options = {password: '', double: false}
+OptionParser.new do |opts|
+  opts.banner = "Usage: cs password [options]"
+
+  opts.on("-p", "--password password", "pass password as command line") do |v|
+    options[:password] = v
+  end
+
+  opts.on("-d", "--double-md5", "Hash the password twice") do
+    options[:double] = true
+  end
+
+  opts.separator ""
+  opts.on_tail("-h", "--help", "Show this message") do
+
+    puts opts
+    exit
+  end
+end.parse!
+
+def hash(plaintext)
+  Digest::MD5.hexdigest(plaintext)
+end
+
+if options[:password].nil? || options[:password].empty?
+  print "password:"
+  v = STDIN.noecho(&:gets).chomp
+  options[:password] = v
+end
+
+retval = hash(options[:password])
+
+retval = hash(retval) if options[:double]
+
+puts
+puts retval

data/cs.gemspec

@@ -8,6 +8,8 @@ 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)/})
@@ -15,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CS::VERSION
   gem.add_development_dependency("launchy", "~> 2.3")
-  gem.add_dependency('httparty', '~> 0.11')
+  gem.add_development_dependency("pry", "~> 0.9.12.6")
+  gem.add_dependency('httparty', '~> 0.12')
   gem.add_dependency('oauth', '~> 0.4')
 end

data/lib/cs.rb

@@ -9,12 +9,17 @@ 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
 
@@ -65,10 +70,10 @@ module CS
     #
     #    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.logger = logger
-      @session.login(user, password)
+      @session.login(user, password, digest)
     end
 
     # Create a new session to CommonSense using username and plain text password
@@ -76,8 +81,8 @@ module CS
     #
     #    client = CS::Client.new
     #    client.login('username', 'password')
-    def login(user, password)
-      login!(user, password) rescue false
+    def login(user, password, digest=true)
+      login!(user, password, digest) rescue false
     end
 
     # Create a new session to CommonSense using OAuth credentials
@@ -100,6 +105,16 @@ module CS
       @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
@@ -133,6 +148,14 @@ module CS
       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
@@ -145,5 +168,9 @@ module CS
       return @session.errors if @session
     end
   end
+
+  def self.load_CLI
+    require "cs/cli/cli"
+  end
 end