beeline_iot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dff332f70983247cdca25af086bad6f04ab8ea349bdbea8cae6a14541c2391c5
+  data.tar.gz: c24d7a751c0ed7a050759026c7a4243a4547316374e5565e0a2f81c25874da03
+SHA512:
+  metadata.gz: bebaca511a9caaca1a5111d6d154be94c27a9618845812b0998f7c4b51ac88ae10327d069feb9961ced7f0ffc87dd87c6b416116145a5e04c75c81d018b0e035
+  data.tar.gz: e3149709e0b3ee0eae1fd2323c4c34de6e38ad3c5a112cc84f20c3b8380ca9d768818fcb6fccd1a4c0d4824c7f90eacd157cabb5f5999688323cc359065ef76f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2024 Vladislav Kostikov
+
+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,95 @@
+# Beeline IoT M2M
+[![Gem Version](https://badge.fury.io/rb/beeline_iot.svg)](https://badge.fury.io/rb/beeline_iot)
+
+Библиотека для взаимодействия с Центром Управления IoT M2M Билайн Бизнес.  
+[Официальный сайт](https://iot.beeline.ru/)  
+[Официальная документация](https://iot.beeline.ru/#/m2m/api_guide)
+
+## Установка
+
+Добавьте в ваш Gemfile:
+
+`gem "novofon"`
+
+И выполните команду:
+
+`bundle install`
+
+Или установите с помощью команды:
+
+`gem install novofon`
+
+## Использование
+
+C помощью модуля:
+
+```ruby
+# Авторизация.
+auth_data = {
+  username: "e1xx",
+  password: "qweqwe",
+  client_id: "3",
+  client_secret: "7LWdlTpx9PYrqUz0sy28mlFH1pt38fPgqOkfkzBc",
+  grant_type: "password"
+}
+BeelineIot::Client.login(auth_data)
+
+# Также возможно задать авторизационные данные так.
+BeelineIot.grant_type = "password"
+BeelineIot.log_requests = false # по-умолчанию
+
+# Получение списка сим-карт.
+dashboard_id = 12345
+response = BeelineIot::Client.request(
+  :post, 
+  "/api/v0/dashboards/#{dashboard_id}/sim_cards/list_all_sim"
+)
+
+# Получение списка сим-карт доступным методом.
+dashboard_id = 12345
+response = BeelineIot::Client.sim_list(dashboard_id)
+```
+
+С помощью экземпляра класса:
+
+```ruby
+# Авторизация.
+auth_data = {
+  username: "e1xx",
+  password: "qweqwe",
+  client_id: "3",
+  client_secret: "7LWdlTpx9PYrqUz0sy28mlFH1pt38fPgqOkfkzBc",
+  grant_type: "password"
+}
+client = BeelineIot::Client.new(auth_data)
+client.login(auth_data)
+
+# Получение информации по SIM-карте, дополнительные параметры тоже можно передавать.
+dashboard_id = 12345
+params = { per_page: 5 }
+response = BeelineIot::Client.request(
+  :get,
+  "/api/v0/dashboards/#{dashboard_id}/sim_cards/#{sim_id}",
+  params
+)
+
+# Получение информации по SIM-карте доступным методом, дополнительные параметры тоже можно передавать.
+dashboard_id = 12345
+sim_id = 987654
+params = { order: { id: "asc" } }
+response = BeelineIot::Client.get_sims(dashboard_id, sim_id, params)
+```
+
+## Доступные методы
+
+Вы можете использовать доступные методы или метод `.request()` в таком формате:
+
+```ruby
+BeelineIot::Client.request(:method, "path", params = {})
+client.request(:method, "path", params = {})
+```
+
+* `sim_list(dashboard_id, params = {})` - список SIM-карт
+* `get_sims(dashboard_id, sim_id, params = {})` - получение информации по SIM-карте
+* `rate_plans(dashboard_id, params = {})` - список тарифных планов
+* `communication_plans(dashboard_id, params = {})` - список услуг

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/beeline_iot/client.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# require "digest/md5"
+require "openssl"
+# require "base64"
+require "faraday"
+
+require "beeline_iot/methods"
+
+module BeelineIot
+  class Client
+    include Methods
+
+    def initialize(auth_data = {})
+      @username = auth_data[:username]
+      @password = auth_data[:password]
+      @client_id = auth_data[:client_id]
+      @client_secret = auth_data[:client_secret]
+      @grant_type = auth_data[:grant_type]
+      @token_type = auth_data[:token_type]
+      @expires_in = auth_data[:expires_in]
+      @access_token = auth_data[:access_token]
+      @refresh_token = auth_data[:refresh_token]
+    end
+
+    def login(auth_data)
+      return self if @access_token
+
+      response = request :post, "/oauth/token", auth_data
+      @token_type = response["token_type"]
+      @expires_in = response["expires_in"]
+      @access_token = response["access_token"]
+      @refresh_token = response["refresh_token"]
+      self
+    end
+
+    def request(method, path, params = {})
+      raise "No auth data provided" unless enough_auth_data?
+
+      params = params.to_json
+      response = client.send(method, path, params) do |request|
+        add_request_headers(request, path)
+      end
+
+      result = ActiveSupport::JSON.decode(response.body)&.with_indifferent_access
+      raise BeelineIot::Error, "Error [HTTP #{response.status}]: #{response.reason_phrase}" unless response.success?
+
+      result
+    rescue ActiveSupport::JSON.parse_error
+      raise BeelineIot::Error, "Response is not JSON: #{response.body}"
+    end
+
+    private
+
+    def client
+      @client ||= ::Faraday.new(url: "https://iot.beeline.ru") do |faraday|
+        faraday.request :url_encoded
+        faraday.response :logger if BeelineIot.log_requests
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def add_request_headers(request, path)
+      request.headers["Content-Type"] = "application/json"
+      return if path == "/oauth/token"
+
+      request.headers["X-Requested-With"] = "XMLHttpRequest" unless path == "/oauth/token"
+      request.headers["Authorization"] = "#{@token_type} #{@access_token}"
+    end
+
+    def enough_auth_data?(data: {})
+      if [@token_type, @access_token].all? ||
+         [@username, @password, @client_id, @client_secret, @grant_type].all?
+        return true
+      end
+
+      false
+    end
+
+    # Class methods
+    class << self
+      include Methods
+
+      def login(auth_data)
+        client = BeelineIot::Client.new(auth_data)
+        response = client.request :post, "/oauth/token", auth_data
+        BeelineIot.username = auth_data[:username]
+        BeelineIot.password = auth_data[:password]
+        BeelineIot.client_id = auth_data[:client_id]
+        BeelineIot.client_secret = auth_data[:client_secret]
+        BeelineIot.grant_type = auth_data[:grant_type]
+        BeelineIot.token_type = response["token_type"]
+        BeelineIot.expires_in = response["expires_in"]
+        BeelineIot.access_token = response["access_token"]
+        BeelineIot.refresh_token = response["refresh_token"]
+        BeelineIot
+      end
+
+      def request(method, path, params = {})
+        client = BeelineIot::Client.new(
+          username: BeelineIot.username,
+          password: BeelineIot.password,
+          client_id: BeelineIot.client_id,
+          client_secret: BeelineIot.client_secret,
+          grant_type: BeelineIot.grant_type,
+          token_type: BeelineIot.token_type,
+          expires_in: BeelineIot.expires_in,
+          access_token: BeelineIot.access_token,
+          refresh_token: BeelineIot.refresh_token
+        )
+        client.request(method, path, params)
+      end
+    end
+  end
+end

data/lib/beeline_iot/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BeelineIot
+  class Error < StandardError
+  end
+end

data/lib/beeline_iot/methods.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BeelineIot
+  module Methods
+    def sim_list(dashboard_id, params = {})
+      request(:post, "/api/v0/dashboards/#{dashboard_id}/sim_cards/list_all_sim", params)
+    end
+
+    def get_sims(dashboard_id, sim_id, params = {})
+      request(:get, "/api/v0/dashboards/#{dashboard_id}/sim_cards/#{sim_id}", params)
+    end
+
+    def rate_plans(dashboard_id, params = {})
+      request(:post, "/api/v0/dashboards/#{dashboard_id}/rate_plans", params)
+    end
+
+    def communication_plans(dashboard_id, params = {})
+      request(:post, "/api/v0/dashboards/#{dashboard_id}/communication_plans", params)
+    end
+  end
+end

data/lib/beeline_iot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BeelineIot
+  VERSION = "1.0.0"
+end

data/lib/beeline_iot.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+require "active_support/json"
+require "active_support/hash_with_indifferent_access"
+
+require_relative "beeline_iot/version"
+
+require "beeline_iot/client"
+require "beeline_iot/error"
+require "beeline_iot/methods"
+
+module BeelineIot
+  mattr_accessor :username,
+                 :password,
+                 :client_id,
+                 :client_secret,
+                 :grant_type,
+                 :token_type,
+                 :expires_in,
+                 :access_token,
+                 :refresh_token,
+                 :log_requests
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: beeline_iot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vladislav Kostikov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+description:
+email:
+- vlad@kostikov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/beeline_iot.rb
+- lib/beeline_iot/client.rb
+- lib/beeline_iot/error.rb
+- lib/beeline_iot/methods.rb
+- lib/beeline_iot/version.rb
+homepage: https://github.com/vladkostikov/beeline_iot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vladkostikov/beeline_iot
+  source_code_uri: https://github.com/vladkostikov/beeline_iot
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Beeline IoT M2M
+test_files: []