ince-api 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e17827a7e3e5724f8d6943ea91ac68c2248cd35563c6dd96208e23c5e828676
+  data.tar.gz: 687a059f3c92bafeaad731767b9210fdacad53c6987607425f3f2a26aec20fa2
+SHA512:
+  metadata.gz: 9a4e2b50f07b1852b0fdf6c5a6bf0bd3dfe603ebf46923497f8844eb58ee3aa9be16bec7ea4f72f5d79283e4f31723c837f51d6d68279b37c8a2f5316dc19389
+  data.tar.gz: 2bf6f3da38ae721808c4e0656309a9d1aa1438142eb7c9f5f8de03eb69ea6572accbf6a0c0753c02aeb83f4f4e1780022a200bbc328761f093c861f92ba3d1f8

data/README.md

@@ -0,0 +1,54 @@
+# ince-api
+Wrapper for 1nce API [API documentation](https://help.1nce.com/dev-hub/reference/api-welcome)
+
+## Instalation
+
+The ince-api gem is available at rubygems.org. You can install with:
+
+`gem install ince-api`
+
+Alternatively, you can install the gem with bundler:
+
+\# Gemfile
+
+`gem 'ince-api'`
+
+After doing bundle install, you should have the gem installed in your bundle.
+
+## Generating Access Token
+In order to access 1nce API you need to add new API user in 1nce Admin panel.
+
+If you want to authenticate and obtain Access Token you need to run following code
+
+```ruby
+InceApi::CreateAccessToken.new(username: '<<YOUR USERNAME>>',
+                               password: '<<YOUR PASSWORD>>').create_token
+```
+which will return data of following structure
+
+`{"status_code"=>200, "access_token"=>"eyJpZHRvoiZXl[..]hTXp0dWHpBIn0=", "token_type"=>"bearer", "expires_in"=>3600, "userId"=>"user", "scope"=>"all"}`
+
+or 
+
+`{"statusCode"=>400, "errorCode"=>"CognitoAuthenticationError", "message"=>"Incorrect username or password."}`
+
+if authentication failed
+
+## Getting SIM values
+
+If you want to retrieve list of your SIM card you need to use the Access Token generated before. You can pass params hash - according to [DOCS](https://help.1nce.com/dev-hub/reference/general-sim#getsimsusingget)
+
+```ruby
+token = InceApi::CreateAccessToken.new(username: '<<YOUR USERNAME>>', password: '<<YOUR PASSWORD>>').create_token['access_token']
+sims = InceApi::GetSims.new(access_token: token, params: <<PARAM HASH>>).sims
+```
+
+which will return data of following structure
+
+`[{"iccid"=>"XXXXXXXXXXXXXXX", "imsi"=>"XXXXXXXXXXXXXX", "msisdn"=>"XXXXXXXXXXXXXXXXX", "imei"=>"XXXXXXXXXXXXXX", "imei_lock"=>false, "status"=>"Enabled", "activation_date"=>"2021-08-26T12:13:06.000+0000", "ip_address"=>"XX.XXX.XXX.X", "current_quota"=>500, "quota_status"=>{"id"=>0, "description"=>"More than 20% available"}, "current_quota_SMS"=>250, "quota_status_SMS"=>{"id"=>0, "description"=>"More than 20% available"}},[...]`
+
+You can also fetch single card
+```ruby
+token = InceApi::CreateAccessToken.new(username: '<<YOUR USERNAME>>', password: '<<YOUR PASSWORD>>').create_token['access_token']
+sims = InceApi::GetSim.new(access_token: token, iccid: 'XXXXXXXXX').sim
+```

data/ince-api.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'ince-api'
+  s.version     = '0.0.3'
+  s.summary     = "1nce API wrapper"
+  s.description = "A simple wrapper for 1nce API"
+  s.authors     = ["Stanislaw Zawadzki"]
+  s.email       = 'st.zawadzki@gmail.com'
+  s.homepage    = 'https://rubygems.org/gems/ince-api'
+  s.license       = 'MIT'
+
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.license       = 'MIT'
+  s.add_dependency 'uri', '~> 0.11'
+  s.add_dependency 'net-http', '~> 0.2'
+  s.add_dependency 'openssl', '~> 2.2'
+  s.add_dependency 'base64', '~> 0.1'
+  s.add_development_dependency 'pry', '~> 0.13'
+end
+

data/lib/ince-api.rb

@@ -0,0 +1,9 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+require 'base64'
+
+require_relative 'ince_api/create_access_token'
+require_relative 'ince_api/get_sims'
+require_relative 'ince_api/get_sim'
+require_relative 'ince_api/single_sim_configuration'

data/lib/ince_api/create_access_token.rb

@@ -0,0 +1,36 @@
+require 'json'
+
+module InceApi
+  class CreateAccessToken
+    def initialize(username:, password:)
+      @username = username
+      @password = password
+    end
+
+    URL = URI("https://api.1nce.com/management-api/oauth/token")
+
+    def create_token
+      response = connection.request(request)
+      JSON.parse(response.body)
+    end
+
+    def request
+      Net::HTTP::Post.new(URL).tap do |request|
+        request["Accept"] = 'application/json'
+        request["Content-Type"] = 'application/x-www-form-urlencoded'
+        request["Authorization"] = "Basic #{encoded_credentials}"
+        request.body = "grant_type=client_credentials"
+      end
+    end
+
+    def connection
+      @connection ||= Net::HTTP.new(URL.host, URL.port).tap do |http|
+        http.use_ssl = true
+      end
+    end
+
+    def encoded_credentials
+      Base64.encode64("#{@username}:#{@password}").strip
+    end
+  end
+end

data/lib/ince_api/get_sim.rb

@@ -0,0 +1,32 @@
+module InceApi
+  class GetSim
+    def initialize(access_token:, iccid:)
+      @access_token = access_token
+      @iccid = iccid
+    end
+
+    def sim
+      response = connection.request(request)
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def url
+      @url ||= URI("https://api.1nce.com/management-api/v1/sims/#{@iccid}")
+    end
+
+    def connection
+      @connection ||= Net::HTTP.new(url.host, url.port).tap do |http|
+        http.use_ssl = true
+      end
+    end
+
+    def request
+      Net::HTTP::Get.new(url).tap do |request|
+        request["Accept"] = 'application/json'
+        request['Authorization'] = "Bearer #{@access_token}"
+      end
+    end
+  end
+end

data/lib/ince_api/get_sims.rb

@@ -0,0 +1,37 @@
+module InceApi
+  class GetSims
+    def initialize(access_token:, params: {})
+      @access_token = access_token
+      @params = params
+    end
+
+    def sims
+      response = connection.request(request)
+      JSON.parse(response.body)
+    end
+
+    private
+
+    ALLOWED_KEYS = %i(page pageSize q sort)
+    def params_query
+      URI.encode_www_form @params.slice(*ALLOWED_KEYS)
+    end
+
+    def url
+      @url ||= URI("https://api.1nce.com/management-api/v1/sims?#{params_query}")
+    end
+
+    def connection
+      @connection ||= Net::HTTP.new(url.host, url.port).tap do |http|
+        http.use_ssl = true
+      end
+    end
+
+    def request
+      Net::HTTP::Get.new(url).tap do |request|
+        request["Accept"] = 'application/json'
+        request['Authorization'] = "Bearer #{@access_token}"
+      end
+    end
+  end
+end

data/lib/ince_api/single_sim_configuration.rb

@@ -0,0 +1,40 @@
+module InceApi
+  class SingleSimConfiguration
+    def initialize(access_token:, iccid:, params:{})
+      @access_token = access_token
+      @iccid = iccid
+      @params = params
+    end
+
+    def update
+      response = connection.request(request)
+      response.code.to_i == 200 ? allowed_params.merge(status: 'OK') : { status: 'FAILED', error_code: response.code.to_i}
+    end
+
+    private
+
+    ALLOWED_KEYS = %i(label imei_lock status)
+    def allowed_params
+      @params.slice(*ALLOWED_KEYS)
+    end
+
+    def url
+      @url ||= URI("https://api.1nce.com/management-api/v1/sims/#{@iccid}")
+    end
+
+    def connection
+      @connection ||= Net::HTTP.new(url.host, url.port).tap do |http|
+        http.use_ssl = true
+      end
+    end
+
+    def request
+      Net::HTTP::Put.new(url).tap do |request|
+        request.body = allowed_params.to_json
+        request["Accept"] = 'application/json'
+        request["Content-Type"] = 'application/json;charset=UTF-8'
+        request['Authorization'] = "Bearer #{@access_token}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: ince-api
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Stanislaw Zawadzki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: A simple wrapper for 1nce API
+email: st.zawadzki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- ince-api.gemspec
+- lib/ince-api.rb
+- lib/ince_api/create_access_token.rb
+- lib/ince_api/get_sim.rb
+- lib/ince_api/get_sims.rb
+- lib/ince_api/single_sim_configuration.rb
+homepage: https://rubygems.org/gems/ince-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: 1nce API wrapper
+test_files: []