simple_desk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c837638e0f2659034aa5a4c8b25215d7cdf0c302
-  data.tar.gz: 37f725e2a1109bb1e7fbc583a1c0be5b41d597dc
+  metadata.gz: e55d130b67924254d3ce35e5304e85c3a24ebfc7
+  data.tar.gz: 6d5ddf600020468187e31018176219d5515b8a08
 SHA512:
-  metadata.gz: 37529b54d884a61c95e4b8ee190380160672953d0187c7b35b7dc92413b4b85566837be8d71e864a601e8ebaa6a9c50ce5e09b6b3b6d27f379b7ef6be3bf1831
-  data.tar.gz: 1575762f6493ef5a52c2fa0c19593bb6e554e72940c52f33d3a1f2c99b0cfa3bbbb88f3d479975520e25503fe061db9e0ab6e90c173362a9574f8804f2a97e52
+  metadata.gz: f371a2f54d8dc74aa58d6e5650d1313a70ffc697927d4be771bc791dd7b1cb9dd948ebd69bbd54241898051c106a584ab1ff0c567778cf896225ea6dc8a4d8d1
+  data.tar.gz: 44f488cb5fd882c96dc53ed70f7e6f5fa88544f053ac43dd773362c65e209a13da14f33b54933b0934d97445546fbaae3415b7ae700e0e017c9d047c58b120e9

data/README.md

@@ -6,6 +6,8 @@
 
 		- Make generator to accept your API key
 		- Add ability to pass in properties and convert to base 64
+		- Add auto capitalization for names
+		- Parse formatting for phone number
 
 ## Installation
 
@@ -23,8 +25,32 @@ Or install it yourself as:
 
 ## Usage
 
-		a = Api.new
-		a.add_customer({phone_number: "1231231234"})
+#Adding Customers
+To get started and add a new customer, run:
+		SimpleDesk.add_customer({phone_number: "1231231232"})
+
+While `phone_number` is required, you can pass additional properties in:
+		- phone_number (required)
+		- email (optional)
+		- first_name (optional)
+		- last_name (optional)
+
+Like this:
+		
+		params = {phone_number: "1231231232", email: "elijah@example.com", first_name: "Elijah", last_name: "Murray"}
+		SimpleDesk.add_customer(params)
+
+
+#Messaging
+To message a user the format is similar
+Note: They do not have to be existing in the system to message. You'll automatically create a new user if you message a new phone number
+
+		message_and_phone_number = {to: 5551231234, text: "Howdy partner!"}
+		SimpleDesk.message_customer(message_and_phone_number)
+		
+
+
+or you if you want to pass in other details, you can 
 
 ## Contributing
 

data/RELEASE.md

@@ -0,0 +1,3 @@
+v 0.2.0
+-------
+Add documentation

data/lib/simple_desk/version.rb

@@ -1,3 +1,3 @@
 module SimpleDesk
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/simple_desk.rb

@@ -13,7 +13,12 @@ module SimpleDesk
 	end	
 	# alias_method :update_customer, :add_customer
 
+	def self.message_customer(message_and_phone_number)
+		uri = URI.parse(post_url("message_customer"))
+		response = Net::HTTP.post_form(uri, message_and_phone_number)
+	end	
 
+	private
 	def self.build_url(post_type = nil, params=nil)
 		url = post_url(post_type)
 
@@ -42,9 +47,4 @@ module SimpleDesk
 		end
 	end
 
-	def self.message_customer(message_and_phone_number)
-		uri = URI.parse(post_url("message_customer"))
-		response = Net::HTTP.post_form(uri, message_and_phone_number)
-	end	
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_desk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Elijah Murray
@@ -77,6 +77,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASE.md
 - Rakefile
 - lib/simple_desk.rb
 - lib/simple_desk/version.rb