smstools_api 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e7f08aab83edfe08f0ac3198c2a566cd697c82074eb7ca6fd03794fd1e6f61c
+  data.tar.gz: 95b5b7b88144956dde519df037b1316443d7c89d30fdab3f002ac146469e11e5
+SHA512:
+  metadata.gz: b1f3cc3e080c49499987f9cf1c01ade368bd0b0ddeba804c18758adbbec4e6ab600d82cc3a399678f7571a2751ce8cc89ba88d71040991aa26c3f5e8352d172f
+  data.tar.gz: e2ac7bf51bccca62000b67a913318531be40760c59bbb2a225da5dc8747537872951014053e33a1cc9e9fd968783e8ddeeef834d8b203d7680cc955324277f44

data/.github/workflows/gem-push.yml

@@ -0,0 +1,48 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+    paths:
+      - 'lib/**/version.rb'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 3.2
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: 3.2.2
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 3.1.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tom@degrunt.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Tom de Grunt
+
+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,52 @@
+# SmstoolsApi
+
+Smstools API - https://www.smstools.nl/nl/sms-gateway-api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smstools_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install smstools_api
+
+## Usage
+
+For text messages:
+```ruby
+@client = SmstoolsApi::Client.new(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
+response = @client.messages.create(message: "Hi", to: "+31612345678", sender: "Ruby SDK")
+```
+
+For voice messages:
+```ruby
+@client = SmstoolsApi::Client.new(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
+response = @client.voice_messages.create(message: "Hi", to: "+31612345678", sender: "Ruby SDK")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/entdec/smstools_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/entdec/smstools_api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SmstoolsApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/entdec/smstools_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smstools_api"
+
+# 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 "irb"
+IRB.start(__FILE__)

data/bin/setup

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

data/fixtures/vcr_cassettes/messages.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+  - request:
+      method: post
+      uri: https://api.smsgatewayapi.com/v1/message/send
+      body:
+        encoding: UTF-8
+        string: '{"to":"+3161245678","message":"Hello this is a test message!","sender":"Ruby SDK"}'
+      headers:
+        User-Agent:
+          - Faraday v2.11.0
+        Content-Type:
+          - application/json
+        accept:
+          - application/json
+        x-client-id:
+          - "434421713782941511298"
+        X-Client-Secret:
+          - FGbWCZrjtY64E31BaBkz9
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        date:
+          - Wed, 28 Aug 2024 13:04:54 GMT
+        access-control-allow-origin:
+          - "*"
+        access-control-allow-headers:
+          - X-Client-Id, X-Client-Secret, X-Authorization, Content-Type
+        access-control-allow-methods:
+          - GET, POST, PUT, PATCH, DELETE, OPTIONS
+        vary:
+          - Accept-Encoding
+        content-encoding:
+          - gzip
+        content-length:
+          - "66"
+        content-type:
+          - application/json; charset=utf-8
+      body:
+        encoding: UTF-8
+        string: '{"messageid":"e0ncuxht345hjmbjvv2feky0azflcw"}'
+    recorded_at: Wed, 28 Aug 2024 13:04:54 GMT
+recorded_with: VCR 6.2.0

data/fixtures/vcr_cassettes/voice_messages.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+  - request:
+      method: post
+      uri: https://api.smsgatewayapi.com/v1/voice/send
+      body:
+        encoding: UTF-8
+        string:
+          '{"to":"+3161245678","message":"Hello this is a test message!","sender":"Ruby
+          SDK"}'
+      headers:
+        User-Agent:
+          - Faraday v2.11.0
+        Content-Type:
+          - application/json
+        accept:
+          - application/json
+        x-client-id:
+          - "434421713782941511298"
+        X-Client-Secret:
+          - FGbWCZrjtY64E31BaBkz9
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        date:
+          - Thu, 29 Aug 2024 12:54:50 GMT
+        access-control-allow-origin:
+          - "*"
+        access-control-allow-headers:
+          - X-Client-Id, X-Client-Secret, X-Authorization, Content-Type
+        access-control-allow-methods:
+          - GET, POST, PUT, PATCH, DELETE, OPTIONS
+        vary:
+          - Accept-Encoding
+        content-encoding:
+          - gzip
+        content-length:
+          - "66"
+        content-type:
+          - application/json; charset=utf-8
+      body:
+        encoding: UTF-8
+        string: '{"messageid":"ug3g0s0aa7qahuujjkdknhwigvrcjy"}'
+    recorded_at: Thu, 29 Aug 2024 12:54:50 GMT
+recorded_with: VCR 6.2.0

data/lib/smstools_api/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'smstools_api/middleware/response/hashie_json'
+require 'smstools_api/middleware/request/authorization'
+require 'smstools_api/messages'
+require 'smstools_api/voice_messages'
+
+module SmstoolsApi
+  class Client
+    extend Forwardable
+
+    attr_reader :config, :messages, :voice_messages
+
+    def initialize(config = {})
+      @config = Hashie::Mash.new(config)
+      @messages = Messages.new(self)
+      @voice_messages = VoiceMessages.new(self)
+    end
+
+    private
+
+    delegate %i[get post put delete head patch options trace] => :connection
+
+    def connection
+      @connection ||= build_connection
+    end
+
+    def build_connection
+      Faraday.new('https://api.smsgatewayapi.com/v1') do |builder|
+        # Request
+        builder.request :json
+        builder.use SmstoolsApi::Middleware::Request::Authorization, self
+
+        # Response
+        builder.use SmstoolsApi::Middleware::Response::HashieJson, self
+      end
+    end
+  end
+end

data/lib/smstools_api/messages.rb

@@ -0,0 +1,13 @@
+module SmstoolsApi
+  class Messages
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create(message:, to:, sender:, date: nil, reference: nil, test: false, subid: nil)
+      @client.post('message/send', to: to, message: message, sender: sender)
+    end
+  end
+end

data/lib/smstools_api/middleware/request/authorization.rb

@@ -0,0 +1,30 @@
+require "faraday/middleware"
+
+module SmstoolsApi
+  # @private
+  module Middleware
+    # @private
+    module Request
+      class Authorization < Faraday::Middleware
+
+        ACCEPT = "accept".freeze
+        CLIENTID = "x-client-id".freeze
+        CLIENTSECRET = "X-Client-Secret".freeze
+
+        attr_reader :client
+
+        def initialize(app, client)
+          super(app)
+          @client = client
+        end
+
+        def call(env)
+          env.request_headers[ACCEPT] = "application/json"
+          env.request_headers[CLIENTID] = client.config.client_id
+          env.request_headers[CLIENTSECRET] = client.config.client_secret
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/smstools_api/middleware/response/hashie_json.rb

@@ -0,0 +1,27 @@
+module SmstoolsApi
+  # @private
+  module Middleware
+    # @private
+    module Response
+      class HashieJson < Faraday::Middleware
+        CONTENT_TYPE = "Content-Type".freeze
+
+        def initialize(app, client)
+          super(app)
+          @client = client
+        end
+
+        def on_complete(env)
+          type = env[:response_headers][CONTENT_TYPE].to_s
+          type = type.split(";", 2).first if type.index(";")
+
+          return unless type == "application/json"
+
+          unless env[:body].strip.empty?
+            env[:body] = Hashie::Mash.new(JSON.parse(env[:body]))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smstools_api/version.rb

@@ -0,0 +1,3 @@
+module SmstoolsApi
+  VERSION = "0.1.3"
+end

data/lib/smstools_api/voice_messages.rb

@@ -0,0 +1,13 @@
+module SmstoolsApi
+  class VoiceMessages
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create(message:, to:, sender:, date: nil, reference: nil, language: nil, gender: nil, test: false)
+      @client.post('voice/send', to: to, message: message, sender: sender)
+    end
+  end
+end

data/lib/smstools_api.rb

@@ -0,0 +1,11 @@
+require "faraday"
+require "hashie"
+require 'debug'
+
+require "smstools_api/client"
+require "smstools_api/version"
+
+module SmstoolsApi
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/smstools_api.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/smstools_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'smstools_api'
+  spec.version = SmstoolsApi::VERSION
+  spec.authors = ['Tom de Grunt']
+  spec.email = ['tom@degrunt.nl']
+
+  spec.summary = 'Smstools API'
+  spec.description = 'Smstools API'
+  spec.homepage = 'https://github.com/entdec/smstools_api'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/entdec/smstools_api'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '>= 2.9'
+  spec.add_runtime_dependency 'hashie', '>= 5'
+
+  spec.add_development_dependency 'debug'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 1.65'
+  spec.add_development_dependency 'standard', '~> 1.35'
+  spec.add_development_dependency 'vcr', '>= 6'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: smstools_api
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Tom de Grunt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.65'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.35'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+description: Smstools API
+email:
+- tom@degrunt.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/messages.yml
+- fixtures/vcr_cassettes/voice_messages.yml
+- lib/smstools_api.rb
+- lib/smstools_api/client.rb
+- lib/smstools_api/messages.rb
+- lib/smstools_api/middleware/request/authorization.rb
+- lib/smstools_api/middleware/response/hashie_json.rb
+- lib/smstools_api/version.rb
+- lib/smstools_api/voice_messages.rb
+- smstools_api.gemspec
+homepage: https://github.com/entdec/smstools_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/entdec/smstools_api
+  source_code_uri: https://github.com/entdec/smstools_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Smstools API
+test_files: []