vivialconnect 0.0.1

data/lib/vivialconnect/user.rb

@@ -0,0 +1,158 @@
+module VivialConnect 
+  ##
+  #=== .all
+  #
+  #Returns an array containing ruby objects corresponding to all User resources on your account
+  #
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::User.all
+  # => [#<VivialConnect::User account_id=1XXXX, active=true, api_key="User's Api Key", date_created="2017-04-25T09:37:47-04:00", date_modified="2017-04-25T09:38:09-04:00", email="btester@vivial.net", first_name="Bob", id=1XXXX, last_name="Test", roles=[{"active"=>true, "date_created"=>"2016-09-30T19:42:59-04:00", "date_modified"=>"2016-09-30T19:42:59-04:00", "description"=>"Account administrator role", "id"=>3, "name"=>"AccountAdministrator", "role_type"=>"client"}, {"active"=>true, "date_created"=>"2016-09-30T19:42:59-04:00", "date_modified"=>"2016-09-30T19:42:59-04:00", "description"=>"User role", "id"=>X, "name"=>"User", "role_type"=>"client"}], timezone="US/Eastern", username="btester", verified=true>] 
+  #
+  #
+  ##
+  #=== .count
+  #Returns the number of users associated with your account.
+  #
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::User.count
+  # => 7
+  #
+  #
+  #=== .find(id)
+  #
+  #Returns User object with the id provided
+  #
+  #
+  # Required parameter:
+  #
+  # id | Fixnum | 726
+  #
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::User.find(726)
+  # => #<VivialConnect::User account_id=1XXXX, active=true, api_key="apikey", date_created="2016-12-28T11:14:58-05:00", date_modified="2017-04-25T11:59:04-04:00", email="btester@vivial.net", first_name="Bob", id=1XXXX, last_name="Tester", roles=[{"active"=>true, "date_created"=>"2016-09-30T19:42:59-04:00", "date_modified"=>"2016-09-30T19:42:59-04:00", "description"=>"Account administrator role", "id"=>3, "name"=>"AccountAdministrator", "role_type"=>"client"}, {"active"=>true, "date_created"=>"2016-09-30T19:42:59-04:00", "date_modified"=>"2016-09-30T19:42:59-04:00", "description"=>"User role", "id"=>4, "name"=>"User", "role_type"=>"client"}], timezone="US/Eastern", username="btester", verified=true> 
+  #
+  #
+  ##
+  #=== .find_each(start: 1, finish: nil, batch_size: 150)
+  #
+  #Iterates through all of the users on your account in N sized batches and returns an array containing all the users beginning at the `start: value` and ending at the `finish: value`. 
+  #
+  #
+  # When a block is given this method yields an individual User object. 
+  # Without a block, this method returns an Enumerator. 
+  #
+  #
+  # By default, it will begin at the first userr and end at the last user
+  # 
+  # 
+  # With default batch_size: 150, if you wanted to get your records from
+  # 150 to 300 you would start at 2 and finish at 2.
+  #
+  # 
+  # Returns an Array of objects corresponding to the `start` and `finish` values. Default is all objects.
+  #
+  # Optional parameters:
+  #
+  # start      | Fixnum | batch to start with
+  # finish     | Fixnum | batch to end with
+  # batch_size | Fixnum | between 1..150
+  #   
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::User.find_each {|user| puts user.username}
+  # janeuser
+  # => [#<VivialConnect::User account_id=1XXXX>,  ... ]
+  #
+  #
+  ##
+  #===  .find_in_batches(start: 1, finish: nil, batch_size: 150)  
+  # 
+  #Iterates through all of the user on your account in N sized batches and returns an array containing all the users beginning at the `start: value` and ending at the `finish: value`. 
+  # 
+  #
+  # When a block is given this method yields an array of batch_size resource objects. 
+  # Without a block, it returns an Enumerator.
+  #
+  #
+  # By default, it will begin at the first user and end at the last user
+  # 
+  # 
+  # With default batch_size: 150, if you wanted to get your records from
+  # 150 to 300 you would start at 2 and finish at 2.
+  #
+  # 
+  # Returns an Array of objects corresponding to the `start` and `finish` values. Default is all objects.
+  # 
+  # Optional parameters:
+  #
+  # start      | Fixnum | batch to start with
+  # finish     | Fixnum | batch to end with
+  # batch_size | Fixnum | between 1..150
+  #   
+  #
+  # Example usage:
+  #
+  #
+  # VivialConnect::User.find_in_batches {|batch| do_something_with_an_array(batch)}
+  # => [#<VivialConnect::User account_id=1XXXX> , ... ]
+  #
+  #
+  ##
+  #===  .update_password(id, old_pw, new_pw)
+  # 
+  #updates the password for the user with the id passed.
+  #
+  # 
+  # Example usage:
+  #
+  #
+  # VivialConnect::User.update_password(928, "oldpassword", "newpassword")
+  # => true
+  #
+  #
+  ##
+  #===  \#update_password(old_pw, new_pw)
+  # 
+  #updates the password for the user object referenced
+  #
+  # 
+  # Example usage:
+  #
+  #
+  # user = User.find(1)
+  # user.update_password("oldpassword", "newpassword")
+  # => true
+  #
+  # NOTE: there is no need to call .save here. This method updates the database.
+  #
+  #
+  class User < Resource
+
+    def self.update_password(id, old_pw, new_pw) # :nodoc:
+      data = {}
+      data[:user] = {_password: old_pw, password: new_pw}
+      data = data.to_json
+      response = VivialConnect::Client.instance.make_request('PUT', "/users/#{id}/profile/password.json", data) 
+    end
+
+    def update_password(old_pw, new_pw) # :nodoc:
+      raise VivialConnectClientError, "your user object has no id and therefore cannot be updated" if self.id.nil?
+      data = {}
+      data[:user] = {_password: old_pw, password: new_pw}
+      data = data.to_json
+      response = VivialConnect::Client.instance.make_request('PUT', "/users/#{self.id}/profile/password.json", data) 
+    end 
+    
+  end
+end

data/lib/vivialconnect/version.rb

@@ -0,0 +1,3 @@
+module Vivialconnect # :nodoc:
+  VERSION = "0.0.1"
+end

data/lib/vivialconnect/vivial_connect_error.rb

@@ -0,0 +1,2 @@
+class VivialConnectClientError < StandardError # :nodoc:
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: vivialconnect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin LeFurjah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: 'VivialConnect is a simple SMS/MMS API. It''s designed specifically for
+  developers seeking a simple, affordable and scalable messaging solution. For more
+  info visit: https://www.vivialconnect.net/'
+email:
+- jlefurjah@vivial.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vivialconnect.rb
+- lib/vivialconnect/account.rb
+- lib/vivialconnect/attachment.rb
+- lib/vivialconnect/client.rb
+- lib/vivialconnect/configuration.rb
+- lib/vivialconnect/contact.rb
+- lib/vivialconnect/log.rb
+- lib/vivialconnect/message.rb
+- lib/vivialconnect/number.rb
+- lib/vivialconnect/resource.rb
+- lib/vivialconnect/user.rb
+- lib/vivialconnect/version.rb
+- lib/vivialconnect/vivial_connect_error.rb
+homepage: https://vivialconnect.github.io/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: This is an API wrapper gem for integrating with the Vivial Connect text messaging
+  API.
+test_files: []