africansms 0.1.5 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59a614038234ea1d68582630a7b3996a372e6bcfae5b62fe2915ce6ee89ff532
-  data.tar.gz: f1c2f065145ee580e4040d194c4ac8b9a4dee0013ce3fa5c3e77e8525b9ca0fc
+  metadata.gz: 70e252de83e0b8a6e9363c14ba8735315283704df1d1a07eebbc3190ee9f36dd
+  data.tar.gz: e6cb844773a7eb9b0a4b9c2b36353de836d2dbc979ea722df859c3e4fbef300e
 SHA512:
-  metadata.gz: 49d0ecc4955dbc39f032e3a2d2daea7f37080b6fdf45b01231336197b77e9a5817d363e5fc52b4893ce5a9113d514a68f2e3613d71ea2c782f8a836620e0258f
-  data.tar.gz: 0006f5775ffae2c6bf2cbd4607d755db2aea65b88fb668f2ad6090c66c173e0794df7c32b6bc58887fea0bcd6c73e875afd3fcd5379d815b335fc0320172ea92
+  metadata.gz: 450212ce5876e8b425619f0a030377da502f292d86af7724557ba5ee455e6e749c5c1fa7bb27a168521d9bce080bad0ff828c958fdc4a3988491ab123093fcea
+  data.tar.gz: 39c8689099cc513d4e6fef7bfdf31866937443649d84732b96c0ff87ad2cf49e007650a50b8a1fd28a482bc61dea17fd54e8b79dad701f7631c2250f3dc8d868

data/.circleci/config.yml

@@ -0,0 +1,64 @@
+version: 2.1
+
+environment: &environment
+  LOG_LEVEL: WARN
+
+jobs:
+  run_cops:
+    working_directory: ~/repos/africansms
+
+    docker:
+      - image: circleci/ruby:2.6.4-buster-node
+        environment:
+          <<: *environment
+
+    steps:
+      - checkout
+
+      - run:
+          name: check dependencies
+          command: |
+            gem install bundler:2.2.23
+            bundle -v
+            bundle exec ruby -v
+
+      - run:
+          name: install gems
+          command: bundle install && bundle clean
+
+      - run:
+          name: run rubocop
+          command: bundle exec rubocop
+
+  publish_to_rubygems:
+    working_directory: ~/repos/africansms
+
+    docker:
+      - image: circleci/ruby:2.6.4-buster-node
+        environment:
+          <<: *environment
+
+    steps:
+      - checkout
+
+      - run:
+          name: setup Rubygems
+          command: bash .circleci/setup-rubygems.sh
+
+      - run:
+          name: publish to Rubygems
+          command: |
+            gem build africansms.gemspec
+            gem push "africansms-$(git describe --tags).gem"
+
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - run_cops
+      - publish_to_rubygems:
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              ignore: /.*/

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.5.0
+  NewCops: enable
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 300
+
+Layout/LineLength:
+  Max: 120
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in africansms.gemspec
 gemspec
+
+gem 'rubocop', require: false

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    africansms (0.1.0)
+    africansms (0.1.8)
       rest-client (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     http-accept (1.7.0)
@@ -16,15 +17,34 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2021.0704)
     netrc (0.11.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
     rake (13.0.6)
+    regexp_parser (2.1.1)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
+    rexml (3.2.5)
+    rubocop (1.18.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   x86_64-linux
@@ -33,6 +53,7 @@ DEPENDENCIES
   africansms!
   bundler (~> 2.2.23)
   rake (~> 13.0)
+  rubocop
 
 BUNDLED WITH
    2.2.23

data/README.md

@@ -22,7 +22,8 @@ Or install it yourself as:
 
 ### Overview
 
-Africansms is a gem which is an integration of Africastalking SMS service. Before using the gem please take a look on Africastalking SMS service documentation "https://developers.africastalking.com/docs/sms/overview" to get the required configration credentials (api_key, username & shortcode)
+Africansms is an integration of Africastalking SMS service. Before using the gem you should have a knowledge Africastalking SMS service. Documentation URL: https://developers.africastalking.com/docs/sms/overview 
+You have to create an account on AfricasTalking to get the required configration credentials (api_key, username & shortcode).
 
 ### Configuration
 

data/africansms.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.description            = 'Integration of Africastalking SMS service for sending SMS in African regions'
   spec.homepage               = 'https://github.com/ayushagrawal134/africansms'
   spec.license                = 'MIT'
-  spec.required_ruby_version  = '>= 2.3.0'
+  spec.required_ruby_version  = '>= 2.5.0'
   spec.files                  = `git ls-files`.split("\n")
 
   spec.add_dependency 'rest-client', '~> 2.1'

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "africansms"
+require 'bundler/setup'
+require 'africansms'
 
 # 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.
@@ -10,5 +10,5 @@ require "africansms"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/africansms.rb

@@ -3,7 +3,7 @@ require 'africansms/client'
 
 module Africansms
   class AfricansmsError < StandardError; end
-  
+
   class << self
     def configure
       yield configuration

data/lib/africansms/client.rb

@@ -10,10 +10,11 @@ module Africansms
 
     def send_message
       raise(AfricansmsError, 'The message to send should not be empty') unless valid_message?
+
       response = RestClient.post(base_url, request_params, request_header)
       response.body
-    rescue StandardError => error
-      error
+    rescue StandardError => e
+      e
     end
 
     private
@@ -21,7 +22,7 @@ module Africansms
     def request_params
       params.merge(
         username: Africansms.configuration.username!,
-        shortcode: Africansms.configuration.shortcode!,
+        from: Africansms.configuration.shortcode!
       )
     end
 
@@ -33,13 +34,15 @@ module Africansms
     end
 
     def base_url
-      params.dig(:mode).eql?('live') ?
-       'https://api.africastalking.com/version1/messaging' :
+      if params[:mode].eql?('live')
+        'https://api.africastalking.com/version1/messaging'
+      else
         'https://api.sandbox.africastalking.com/version1/messaging'
+      end
     end
 
-   def valid_message?
-     params[:message] && !params[:message].empty? 
-   end
+    def valid_message?
+      params[:message] && !params[:message].empty?
+    end
   end
 end

data/lib/africansms/configuration.rb

@@ -15,7 +15,7 @@ module Africansms
     def username!
       username || raise(AfricansmsError, 'No username specified.')
     end
-    
+
     def shortcode!
       shortcode || raise(AfricansmsError, 'No shortcode specified.')
     end

data/lib/africansms/version.rb

@@ -1,3 +1,3 @@
 module Africansms
-  VERSION = "0.1.5"
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: africansms
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.2
 platform: ruby
 authors:
 - Ayush Agrawal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -60,7 +60,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -86,15 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: AfricasTalking SMS service integration