plivo 4.34.0 → 4.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de4b78ac5799e5ff9f65d3623021fc4e33292bf8
-  data.tar.gz: 4fbef9dc4f1100357020bfdab2e311fd8ba123e0
+  metadata.gz: 8201cbdabff4391e2817f5f463d0d0e0ea8ce901
+  data.tar.gz: 4eab07c89d90f39d164d37c3b873954f9cbaa201
 SHA512:
-  metadata.gz: 15336d49a866cf91315a34668867a7c4dd83691bdf6e4b7d92536f190a849edf0418266af694c039747598e364a4ee881c7390b27ef4df10043425f2c0fee049
-  data.tar.gz: 435fa499c6a611525f7fae8f7f95fccc076d1b31931306977524a5da73b7db7bb4f1648b073445904b86441f0a49b6d923b6f1ea4f42b334d54060942a5264ad
+  metadata.gz: ce66937423df4e70bfb62455c904b818c7882e275a774c2d814881eb6e077ba42ee29d898471e7a1882f2099dbb3fbfdc362dbd141aa9ed087554c2baafb1f86
+  data.tar.gz: 97b29ec6835d373389535e554ff390bd6f0a481a3f53a862a700dbef46400c9ddfe5133507061cb3452f0ee67d3f6d31999638c518be7847797b2d88a125ec9b

data/.gitignore

@@ -12,3 +12,4 @@ tmp/
 bin/
 # rspec failure tracking
 .rspec_status
+ruby-sdk-test/

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 # Change Log
+
+## [4.36.0](https://github.com/plivo/plivo-ruby/tree/v4.36.0) (2022-01-25)
+**Adding new attribute - 'requester_ip' in Get Message and List Mssage APIs**
+- Add `requester_ip` to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message)
+
+## [4.35.0](https://github.com/plivo/plivo-ruby/tree/v4.35.0) (2022-01-18)
+**Adding new attribute - 'message_expiry' in Send Message API**
+- Added new attribute - message_expiry in Send Message API
+
 ## [4.34.0](https://github.com/plivo/plivo-ruby/tree/v4.34.0) (2022-12-16)
 **10DLC: Update Campaign API**
 - Added Update Campaign API

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:3.0.1-alpine
+
+RUN apk update && apk add git vim bash make gcc musl-dev
+
+WORKDIR /usr/src/app
+RUN gem install json --source 'https://rubygems.org/'
+
+# Copy setup script
+COPY setup_sdk.sh /usr/src/app/
+RUN chmod a+x /usr/src/app/setup_sdk.sh
+
+ENTRYPOINT [ "/usr/src/app/setup_sdk.sh" ]

data/Makefile

@@ -0,0 +1,7 @@
+.PHONY: build test
+
+build:
+	docker-compose up --build --remove-orphans
+
+test:
+	docker exec -it $$CONTAINER /bin/bash -c "bundle exec rake"

data/README.md

@@ -9,7 +9,7 @@ The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby a
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'plivo', '>= 4.34.0'
+gem 'plivo', '>= 4.36.0'
 ```
 
 And then execute:
@@ -173,3 +173,23 @@ More examples are available [here](https://github.com/plivo/plivo-examples-ruby)
 
 ## Reporting issues
 Report any feedback or problems with this version by [opening an issue on Github](https://github.com/plivo/plivo-ruby/issues).
+
+## Local Development
+> Note: Requires latest versions of Docker & Docker-Compose. If you're on MacOS, ensure Docker Desktop is running.
+1. Export the following environment variables in your host machine:
+```bash
+export PLIVO_AUTH_ID=<your_auth_id>
+export PLIVO_AUTH_TOKEN=<your_auth_token>
+export PLIVO_API_DEV_HOST=<plivoapi_dev_endpoint>
+export PLIVO_API_PROD_HOST=<plivoapi_public_endpoint>
+```
+2. Run `make build`. This will create a docker container in which the sdk will be setup and dependencies will be installed.
+> The entrypoint of the docker container will be the `setup_sdk.sh` script. The script will handle all the necessary changes required for local development.
+3. The above command will print the docker container id (and instructions to connect to it) to stdout.
+4. The testing code can be added to `<sdk_dir_path>/ruby-sdk-test/test.rb` in host  
+ (or `/usr/src/app/ruby-sdk-test/test.rb` in container)
+5. The sdk directory will be mounted as a volume in the container. So any changes in the sdk code will also be reflected inside the container.
+> To use the local code in the test file, import the sdk in test file using:   
+`require "/usr/src/app/lib/plivo.rb"`   
+6. To run unit tests, run `make test CONTAINER=<cont_id>` in host, where `<cont_id>` is the docker container id created in 2.   
+(The docker container should be running)

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '3'
+
+services:
+
+  rubySDK:
+    build: 
+      context: .
+    image: rubysdk
+    container_name: rubySDK
+    environment:
+      - PLIVO_AUTH_ID=${PLIVO_AUTH_ID}
+      - PLIVO_AUTH_TOKEN=${PLIVO_AUTH_TOKEN}
+      - PLIVO_API_DEV_HOST=${PLIVO_API_DEV_HOST}
+      - PLIVO_API_PROD_HOST=${PLIVO_API_PROD_HOST}
+    volumes:
+      - .:/usr/src/app
+    stdin_open: true 
+    tty: true

data/lib/plivo/resources/messages.rb

@@ -30,7 +30,8 @@ module Plivo
           total_amount: @total_amount,
           total_rate: @total_rate,
           powerpack_id: @powerpack_id,
-          units: @units
+          units: @units,
+          requester_ip: @requester_ip
         }.to_s
       end
     end
@@ -69,6 +70,7 @@ module Plivo
       # @option options [String] :method The method used to call the url. Defaults to POST.
       # @option options [String] :log If set to false, the content of this message will not be logged on the Plivo infrastructure and the dst value will be masked (e.g., 141XXXXX528). Default is set to true.
       # @option options [String] :trackable set to false
+      # @option options[Int]: message_expiry, int value
       # @option options[List]: media_urls Minimum one media url should be present in Media urls list to send mms. Maximum allowd 10 media urls inside the list (e.g, media_urls : ['https//example.com/test.jpg', 'https://example.com/abcd.gif'])
       # @option options[List]: media_ids Minimum one media ids should be present in Media ids list to send mms. Maximum allowd 10 media ids inside the list (e.g, media_ids : ['1fs211ba-355b-11ea-bbc9-02121c1190q7'])
       
@@ -122,6 +124,11 @@ module Plivo
           if value.key?(:log) &&
             valid_param?(:log, value[:log], [TrueClass, FalseClass], true)
               params[:log] = value[:log]
+          end
+
+          if value.key?(:message_expiry) &&
+            valid_param?(:message_expiry, value[:message_expiry], [Integer, Integer], true)
+              params[:message_expiry] = value[:message_expiry]
           end         
 
           if value.key?(:trackable) &&
@@ -219,6 +226,11 @@ module Plivo
            params[:media_ids] = options[:media_ids]
           end
 
+          if options.key?(:message_expiry) &&
+            valid_param?(:message_expiry, options[:message_expiry], [Integer, Integer], true)
+              params[:message_expiry] = options[:message_expiry]
+          end
+
           if options.key?(:trackable) &&
             valid_param?(:trackable, options[:trackable], [TrueClass, FalseClass], true)
            params[:trackable] = options[:trackable]

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.34.0".freeze
+  VERSION = "4.36.0".freeze
 end

data/setup_sdk.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+set -e
+testDir="ruby-sdk-test"
+GREEN="\033[0;32m"
+NC="\033[0m"
+
+if [ ! $PLIVO_API_PROD_HOST ] || [ ! $PLIVO_API_DEV_HOST ] || [ ! $PLIVO_AUTH_ID ] || [ ! $PLIVO_AUTH_TOKEN ]; then
+    echo "Environment variables not properly set! Please refer to Local Development section in README!"
+    exit 126
+fi
+
+cd /usr/src/app
+
+echo "Setting plivo-api endpoint to dev..."
+find /usr/src/app/lib/ -type f -exec sed -i "s/$PLIVO_API_PROD_HOST/$PLIVO_API_DEV_HOST/g" {} \;
+
+bundle install
+
+if [ ! -d $testDir ]; then
+    echo "Creating test dir..."
+    mkdir -p $testDir
+fi
+
+if [ ! -f $testDir/test.rb ]; then
+    echo "Creating test file..."
+    cd $testDir
+    echo -e "require \"rubygems\"" > test.rb
+    echo -e "require \"/usr/src/app/lib/plivo.rb\"" >> test.rb
+    echo -e "include Plivo\n" >> test.rb
+    echo -e "api = RestClient.new(ENV[\"PLIVO_AUTH_ID\"], ENV[\"PLIVO_AUTH_TOKEN\"])" >> test.rb
+    cd -
+fi
+
+echo -e "\n\nSDK setup complete!"
+echo "To test your changes:"
+echo -e "\t1. Add your test code in <path_to_cloned_sdk>/$testDir/test.rb on host (or /usr/src/app/$testDir/test.rb in the container)"
+echo -e "\t\tNote: To use sdk in test file, import using $GREEN require \"/usr/src/app/lib/plivo.rb\"$NC"
+echo -e "\t2. Run a terminal in the container using: $GREEN docker exec -it $HOSTNAME /bin/bash$NC"
+echo -e "\t3. Navigate to the test directory: $GREEN cd /usr/src/app/$testDir$NC"
+echo -e "\t4. Run your test file: $GREEN ruby test.rb$NC"
+echo -e "\t5. For running unit tests, run on host: $GREEN make test CONTAINER=$HOSTNAME$NC"
+
+# To keep the container running post setup
+/bin/bash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.34.0
+  version: 4.36.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -157,12 +157,15 @@ files:
 - ".rspec"
 - AUTHORS.md
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Jenkinsfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - ci/config.yml
+- docker-compose.yml
 - examples/conference_bridge.rb
 - examples/jwt.rb
 - examples/lookup.rb
@@ -238,6 +241,7 @@ files:
 - lib/plivo/xml/w.rb
 - lib/plivo/xml/wait.rb
 - plivo.gemspec
+- setup_sdk.sh
 homepage: https://github.com/plivo/plivo-ruby
 licenses:
 - MIT