sms_masking 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b494adf46d071e7ff172e8b9d23cf1c5faf55704
-  data.tar.gz: 5c3d92d08d12b4ec3c27196a38ce1f3322a312fc
+  metadata.gz: 205a16f3061343713fc0fb72574a75cff1bce6b7
+  data.tar.gz: 31a933717fb885da39baa7c459d62e0200ebe4ea
 SHA512:
-  metadata.gz: 99246403049676e0900a56e5c5d53fb84a379dcec73f9b76ef13f7bc8751459cfb2246ea7cba6311faf4f53d675f8ad99be81b4be42064dd336715d670cd9cfb
-  data.tar.gz: 0a23160cd262e222b44e7d6fdd558346cfdf42cc94af5400ca13f471582cb5a6a85384ca4a09ce4bf27596e3848cd1f378687d2976bcb34d5a21f4d26eb66092
+  metadata.gz: 4351c62d05964d4ef8fc454e4135e1d37d6af55270a733994151c2a134a90126345d395f7f35571ad654b1b4b05ac011403edf6e74aa91e9a65723743572c8ff
+  data.tar.gz: aadf3565285755c5332c4ce297f13a91f907c8413377a124b0f81a5a02e461dd14ffcb72a86500a98024385a5f7b42bd0a3cbdb636ef9ed8a6764a7065a54888

data/README.md

@@ -6,6 +6,21 @@ SmsMasking allows you to send SMS messages from your Ruby application using serv
 
 This is not official gem of [www.smsmasking.co.id](http://www.smsmasking.co.id/).
 
+# Index
+
+* [Installation](https://github.com/yunanhelmy/sms_masking#installation)
+* [Initialize](https://github.com/yunanhelmy/sms_masking#initialize)
+* [Send an SMS](https://github.com/yunanhelmy/sms_masking#send-an-sms)
+* [Send SMS by Group](https://github.com/yunanhelmy/sms_masking#send-sms-by-group)
+* [Add Phone Book](https://github.com/yunanhelmy/sms_masking#add-phone-book)
+* [Edit Phone Book](https://github.com/yunanhelmy/sms_masking#edit-phone-book)
+* [Delete Phone Book](https://github.com/yunanhelmy/sms_masking#delete-phone-book)
+* [Get Contact List](https://github.com/yunanhelmy/sms_masking#get-contact-list)
+* [Get Contact List by Group](https://github.com/yunanhelmy/sms_masking#get-contact-list-by-group)
+* [Get Complete Data](https://github.com/yunanhelmy/sms_masking#get-complete-data)
+* [Find Name](https://github.com/yunanhelmy/sms_masking#find-name)
+* [Find Phone Number](https://github.com/yunanhelmy/sms_masking#find-phone-number)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,17 +39,183 @@ Or install it yourself as:
 
 ## Usage
 
-### Initalize
+### Initialize
 
 ```ruby
 sms = SmsMasking::Base.new(username: "your_username", password: "your_password")
 ```
 
-### Send SMS
+Parameters :
+
+* `mobile` : recipient
+* `message` : SMS
+
+### Send an SMS
+
+Purpose : To Send an SMS
+
+Example :
+
 ```ruby
 sms.send_sms({mobile: "085699999999", message: "your_message"})
 ```
 
+Parameters :
+
+- `mobile` : recipient number
+- `message` : SMS
+
+### Send SMS by Group
+
+Purpose : To Send  SMS to a Group
+
+Example :
+
+```ruby
+sms.send_sms_group({group: "My group", msg: "your_message"})
+```
+
+Parameters :
+
+* `group` : Group Name
+* `message` : SMS
+
+### Add Phone Book
+
+Purpose : Add new contact to phone book
+
+Example :
+
+```ruby
+sms.add_phone_book({
+  name: "John Doe", 
+  mobile: "085699999999", 
+  group: "My Group", 
+  address: "My Address",
+  birth: "19900101",
+  desc: "My Description"
+})
+```
+
+Parameters :
+
+* `name` : Contact Name
+* `mobile` : Recipient
+* `group` : Contact Group Name
+* `address` (optional) : Contact Address
+* `birth` (optional) : Contact Birthday (YYYYMMDD)
+* `desc` (optional) : Contact Description
+
+### Edit Phone Book
+
+Purpose : Edit existing Contact
+
+Example :
+
+```ruby
+sms.edit_phone_book({
+  id: 1,
+  name: "John Doe", 
+  mobile: "085699999999", 
+  group: "My Group", 
+  address: "My Address",
+  birth: "19900101",
+  desc: "My Description"
+})
+```
+
+Parameters :
+
+* `id` : Contact ID Number
+* `name` : Contact Name
+* `mobile` : Recipient
+* `group` : Contact Group Name
+* `address` (optional) : Contact Address
+* `birth` (optional) : Contact Birthday (YYYYMMDD)
+* `desc` (optional) : Contact Description
+
+### Delete Phone Book
+
+Purpose :  Delete existing contact
+
+Example :
+
+```ruby
+sms.delete_phone_book({id: 1})
+```
+
+Parameters :
+
+* `id` : Contact ID Number
+
+### Get Contact List
+
+```ruby
+sms.list_phone_book({
+  page: 1, 
+  size: 10
+})
+```
+
+Parameters :
+
+* `page` : Page Number (default=1)
+* `size` : number of records per page (default=10)
+
+### Get Contact List by Group
+
+Purpose : To get Contact list by Group Name
+
+```ruby
+sms.list_phone_book_by_group({
+  page: 1, 
+  size: 10,
+  group: "My Group"
+})
+```
+
+Parameters :
+
+* `page` : Page Number (default=1)
+* `size` : number of records per page (default=10)
+* `group` : Group Name
+
+### Get Complete Data
+
+Purpose : To retrieve contact detail
+
+```ruby
+sms.contact_detail({id: 1})
+```
+
+Parameters :
+
+* `id` : Contact ID Number
+
+### Find Name
+
+Purpose : To search contact by name
+
+```ruby
+sms.find_contact({name: "John Doe"})
+```
+
+Parameters :
+
+* `name` : Name to search
+
+### Find Phone Number
+
+Purpose : To search contact by Phone Number
+
+```ruby
+sms.find_contact({number: "085699999999"})
+```
+
+Parameters :
+
+* `number` : Number to search
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -43,7 +224,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sms_masking. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/yunanhelmy/sms_masking. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/sms_masking/auth.rb

@@ -1,7 +1,7 @@
 module SmsMasking
   module Auth
-    def auth(recipient)
-      Digest::MD5.hexdigest(@username.to_s+@password.to_s+recipient.to_s)
+    def auth(data)
+      Digest::MD5.hexdigest(data)
     end
   end
 end

data/lib/sms_masking/base.rb

@@ -1,20 +1,24 @@
 require 'sms_masking/auth'
 require 'sms_masking/response'
 require 'sms_masking/send_sms'
+require 'sms_masking/phone_book'
 
 module SmsMasking
   class Base
     attr_accessor :username
     attr_accessor :password
+    attr_accessor :base_path
 
     include HTTParty
     include SmsMasking::Auth
     include SmsMasking::SendSms
+    include SmsMasking::PhoneBook
     include SmsMasking::Response
 
     base_uri 'http://send.smsmasking.co.id:8080'
 
     def initialize(params = {})
+      @base_path = "/Web2SMS/api"
       params.each do |key, value| 
         instance_variable_set("@#{key}", value)
       end

data/lib/sms_masking/phone_book.rb

@@ -0,0 +1,149 @@
+module SmsMasking
+  module PhoneBook
+    
+    # ==== Attributes
+    # * +name+ : Contact Name
+    # * +mobile+ : Recipient
+    # * +group+ : Contact Group Name
+    # * +address+ (optional) : Contact Address
+    # * +birth+ (optional) : Contact Birthday (YYYYMMDD)
+    # * +desc+ (optional) : Contact Description
+    #
+    # ==== Example
+    # sms.add_phone_book({
+    #   name: "John Doe", 
+    #   mobile: "085699999999", 
+    #   group: "My Group", 
+    #   address: "My Address",
+    #   birth: "19900101",
+    #   desc: "My Description"
+    # })
+    #
+    def add_phone_book(params = {})
+      params[:username] = @username
+      params[:auth] = auth(params[:mobile]+@password.to_s)
+      res = self.class.get(@base_path+"/phbkAdd.aspx", query: params)
+      print_response res
+    end
+
+    # ==== Attributes
+    # * +id+ : Contact ID Number
+    # * +name+ : Contact Name
+    # * +mobile+ : Recipient
+    # * +group+ : Contact Group Name
+    # * +address+ (optional) : Contact Address
+    # * +birth+ (optional) : Contact Birthday (YYYYMMDD)
+    # * +desc+ (optional) : Contact Description
+    #
+    # ==== Example
+    # sms.edit_phone_book({
+    #   id: 1,
+    #   name: "John Doe", 
+    #   mobile: "085699999999", 
+    #   group: "My Group", 
+    #   address: "My Address",
+    #   birth: "19900101",
+    #   desc: "My Description"
+    # })
+    #
+    def edit_phone_book(params = {})
+      params[:username] = @username
+      params[:auth] = auth(params[:id].to_s+@password.to_s)
+      res = self.class.get(@base_path+"/phbkEdit.aspx", query: params)
+      print_response res
+    end
+
+    # ==== Attributes
+    # * +id+ : Contact ID Number
+    #
+    # ==== Example
+    # sms.delete_phone_book({id: 1})
+    #
+    def delete_phone_book(params = {})
+      params[:username] = @username
+      params[:auth] = auth(params[:id].to_s+@password.to_s)
+      res = self.class.get(@base_path+"/phbkDelete.aspx", query: params)
+      print_response res
+    end
+
+    # ==== Attributes
+    # * +page+ : Page Number (default=1)
+    # * +size+ : number of records per page (default=10)
+    #
+    # ==== Example
+    # sms.list_phone_book({
+    #   page: 1, 
+    #   size: 10
+    # })
+    #
+    def list_phone_book(params = {})
+      params[:username] = @username
+      params[:auth] = auth(@username.to_s+@password.to_s)
+      res = self.class.get(@base_path+"/phbk_getList.aspx", query: params)
+      print_response res
+    end
+
+    # ==== Attributes
+    # * +page+ : Page Number (default=1)
+    # * +size+ : number of records per page (default=10)
+    # * +group+ : Group Name
+    #
+    # ==== Example
+    # sms.list_phone_book_by_group({
+    #   page: 1, 
+    #   size: 10,
+    #   group: "My Group"
+    # })
+    #
+    def list_phone_book_by_group(params = {})
+      params[:username] = @username
+      params[:auth] = auth(@username.to_s+@password.to_s)
+      res = self.class.get(@base_path+"/phbk_getListbyGroup.aspx", query: params)
+      print_response res
+    end
+
+    # ==== Attributes
+    # * +id+ : Contact ID Number
+    #
+    # ==== Example
+    # sms.contact_detail({id: 1})
+    #
+    def contact_detail(params = {})
+      params[:username] = @username
+      params[:auth] = auth(@username.to_s+@password.to_s)
+      res = self.class.get(@base_path+"/phbk_getCompleteData.aspx", query: params)
+      print_response res
+    end
+
+    # ==== Attributes
+    # * +name+ : Name to search
+    #
+    # ==== Example
+    # sms.find_contact({name: "John Doe"})
+    #
+    def find_contact(params = {})
+      params[:username] = @username
+      params[:auth] = auth(@username.to_s+@password.to_s)
+      res = self.class.get(@base_path+"/phbk_findName.aspx", query: params)
+      print_response res
+    end
+
+    # ==== Attributes
+    # * +number+ : Number to search
+    #
+    # ==== Example
+    # sms.find_number({number: "085699999999"})
+    #
+    def find_number(params = {})
+      params[:username] = @username
+      params[:auth] = auth(@username.to_s+@password.to_s)
+      res = self.class.get(@base_path+"/phbk_findPhNumber.aspx", query: params)
+      print_response res
+    end
+    
+
+    
+
+
+  end
+end

data/lib/sms_masking/send_sms.rb

@@ -1,9 +1,32 @@
 module SmsMasking
   module SendSms
+
+    # ==== Attributes
+    # * +mobile+ : recipient
+    # * +message+ : SMS
+    #
+    # ==== Example
+    # sms.send_sms({mobile: "085642568786", message: "your message"})
+    #
     def send_sms(params = {})
       params[:username] = @username
-      params[:auth] = auth(params[:mobile])
-      res = self.class.get("/Web2SMS/api/sendSMS.aspx", query: params)
+      params[:auth] = auth(@username.to_s+@password.to_s+params[:mobile])
+      res = self.class.get(@base_path+"/sendSMS.aspx", query: params)
+      print_response res
+    end
+
+    # ==== Attributes
+    # * +group+ : Group Name
+    # * +message+ : SMS
+    #
+    # ==== Example
+    # sms.send_sms_group({group: "My Group", message: "your message"})
+    #
+    def send_sms_group(params = {})
+      params[:username] = @username
+      params[:auth] = auth(@username.to_s+@password.to_s)
+      params[:msg] = params.delete :message
+      res = self.class.get(@base_path+"/SendSMSGroup.aspx", query: params)
       print_response res
     end
   end

data/lib/sms_masking/version.rb

@@ -1,3 +1,3 @@
 module SmsMasking
-  VERSION = "0.1.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sms_masking
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - yunanhelmy
@@ -87,6 +87,7 @@ files:
 - lib/sms_masking.rb
 - lib/sms_masking/auth.rb
 - lib/sms_masking/base.rb
+- lib/sms_masking/phone_book.rb
 - lib/sms_masking/railtie.rb
 - lib/sms_masking/response.rb
 - lib/sms_masking/send_sms.rb