soracom 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf9c968900c4cc36ed26da56a4b5ffc7a6be2de2
+  data.tar.gz: df2a46235dc380794f02d80c796a34165210b7ac
+SHA512:
+  metadata.gz: 7a20100192a89f3a8c30a42203474242a489d4b430d63c8d29084d06dd3fd2b0469c6c2202c54b65a37904d19d45e4aacc8002702bb5bec9a408f5a70073ca2a
+  data.tar.gz: 14501213f04f904551ce27464aac18c04c3f83e6e705fa8c61b14ffc8a6e16d34bb521394b1601ef13503319b44158b0e7f4d19285c19a22e22b505484f2ec8d

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    soracom (1.0.1)
+      io-console
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    io-console (0.4.2)
+    method_source (0.8.2)
+    pry (0.10.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  pry
+  rake (~> 10.0)
+  rspec
+  soracom!
+
+BUNDLED WITH
+   1.10.3

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Soracom, Inc.
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 MATSUI,Motokatsu
+
+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,138 @@
+# SORACOM SDK for Ruby
+SORACOM SDK for Ruby は、株式会社 SORACOM の提供する IoT プラットフォームの API を Ruby プログラムからコールするためのライブラリとなります。  
+またコマンドラインインターフェース(CLI)も付属していますので、プログラムを組まなくてもシェルスクリプト等から API を呼び出す事が可能となります。
+
+## インストール
+
+```
+$ (sudo) gem install soracom # 環境により sudo が必要となる場合があります
+```
+
+としてインストールする事で、ライブラリおよびコマンドラインインターフェース ( soracom コマンド)が導入されます。
+
+## 使用方法
+
+### SDK
+
+#### 使用例
+サンプルコード: SIMの一覧を取得し、プランを s1.fast に変更する
+```ruby
+#!/usr/bin/env ruby
+require 'soracom'
+
+# SORACOM APIアクセス用クライアントの初期化方法
+# 1. client = Soracom::Client.new(email: '登録メールアドレス', password: 'パスワード')
+# 2. client = Soracom::Client.new
+#   (環境変数 SORACOM_EMAIL & SORACOM_PASSWORD を参照)
+
+client = Soracom::Client.new
+
+# サブスクライバー(SIM)の一覧を取得
+sims = client.list_subscribers
+
+puts "found #{sims.count} SIMs."
+
+# 操作対象のIMSI配列を用意
+imsis = sims.map { |sim| sim['imsi'] }
+
+puts 'change plan to s1.fast'
+
+# プラン変更のためのAPIをコールする
+client.update_subscriber_speed_class(imsis, 's1.fast')
+
+puts 'done'
+
+```
+
+### コマンドラインインターフェース
+#### 認証情報の設定
+環境変数にメールアドレス・パスワードを設定します。
+```
+$ export SORACOM_EMAIL='somebody@example.com'
+$ export SORACOM_PASSWORD='mypassword'
+```
+
+認証情報が正しく設定されているかどうかを確認するには、**soracom auth** コマンドを使用します。
+```
+~$ soracom auth
+testing authentication...
+authentication succeeded.
+apiKey: APIキー
+operatorId: OPで始まるオペレータID
+```
+
+#### 使用例
+SIMの一覧を取得する
+```
+$ soracom subscriber list
+[
+  {
+    (SIMの情報)
+  },
+  :
+  {
+    (SIMの情報)
+  }
+]
+```
+
+出力されたJSONフォーマットのデータから特定のパラメータを抜き出すには、**jq** コマンドが有用です。
+```
+$ soracom subscriber list | jq -r '.[].imsi' | tee imsi.txt
+001010000000000
+001010000000001
+001010000000002
+      :
+```
+
+複数のSIMに対して、プランを s1.fast に変更する
+```
+$ soracom subscriber update_speed_class --imsi $(cat imsi.txt) --type s1.fast
+[
+  {
+    (変更後のSIMの情報)
+  },
+  :
+  {
+    (変更後のSIMの情報)
+  }
+]
+```
+
+#### コマンドライン補完
+利用しているシェルが bash/zsh であれば、
+```
+eval "$(soracom complete)"
+```
+と .bashrc や　.zshrc などに書く事で、soracom コマンドのコマンド名補完が可能です。
+
+```
+$ soracom [tab]
+~$ soracom
+auth           stats
+event_handler  subscriber
+group          support
+sim            version
+
+$ soracom sub[tab]
+
+$ soracom subscriber [tab]
+activate
+deactivate
+delete_tag
+disable_termination
+enable_termination
+help
+list
+register
+set_expiry_time
+set_group
+terminate
+unset_expiry_time
+unset_group
+update_speed_class
+update_tags
+
+$ soracom subscriber li[tab]
+$ soracom subscriber list
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'soracom'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/soracom

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+require 'soracom'
+if ENV['LANG'] =~ /[a-z][a-z]_[A-Z][A-Z]\.UTF-8$/
+  SoracomCli::CLI.start
+else
+  abort "LANG is not set properly to handle UTF-8. Currently set as #{ENV['LANG']}, but it should be xx_XX.UTF-8."
+end

data/lib/soracom/api_client.rb

@@ -0,0 +1,60 @@
+module Soracom
+  # Class to handle API requests
+  class ApiClient
+    def initialize(auth, endpoint)
+      @log = Logger.new(STDERR)
+      @log.level = ENV['SORACOM_DEBUG'] ? Logger::DEBUG : Logger::WARN
+      @auth = auth
+      @endpoint = (endpoint.nil?) ? API_BASE_URL : endpoint
+    end
+
+    def get(path:'', params:{})
+      res = RestClient.get @endpoint + path, accept: 'application/json', params: params, 'X-Soracom-API-Key' => @auth[:apiKey], 'X-Soracom-Token' => @auth[:token]
+      return parse(res.body) if res.body && res.body.length > 0
+      return { result: (res.code =~ /2../) ? 'success' : 'failure' }
+    rescue => evar
+      @log.debug evar
+      return { result: "failure: #{evar}" }
+    end
+
+    def post(path:'', params:{}, payload:{})
+      res = RestClient.post @endpoint + path, payload,
+                            content_type: 'application/json', accept: 'application/json', params: params, 'X-Soracom-API-Key' => @auth[:apiKey], 'X-Soracom-Token' => @auth[:token]
+      return parse(res.body) if res.body && res.body.length > 0
+      return { result: (res.code =~ /2../) ? 'success' : 'failure' }
+    rescue => evar
+      @log.debug evar
+      return { result: "failure: #{evar}" }
+    end
+
+    def put(path:'', params:{}, payload:{})
+      res = RestClient.put @endpoint + path, payload,
+                            content_type: 'application/json', accept: 'application/json', params: params, 'X-Soracom-API-Key' => @auth[:apiKey], 'X-Soracom-Token' => @auth[:token]
+      return parse(res.body) if res.body && res.body.length > 0
+      return { result: (res.code =~ /2../) ? 'success' : 'failure' }
+    rescue => evar
+      @log.debug evar
+      return { result: "failure: #{evar}" }
+    end
+
+    def delete(path:'', params:{})
+      res = RestClient.delete @endpoint + path, accept: 'application/json', params: params, 'X-Soracom-API-Key' => @auth[:apiKey], 'X-Soracom-Token' => @auth[:token]
+      @log.debug res.body
+      return parse(res.body) if res.body && res.body.length > 0
+      return { result: (res.code =~ /2../) ? 'success' : 'failure' }
+    rescue => evar
+      @log.debug evar
+      return { result: "failure: #{evar}" }
+    end
+
+    private
+
+    def parse(response)
+      begin
+        return JSON.parse(response)
+      rescue JSON::ParserError => e
+        return {result: response}
+      end
+    end
+  end
+end