your_membership 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e167609f71a1eb9be5e05117ef8baa58039ba2c9
-  data.tar.gz: 46cb16feb9c4cf28145a18b4ef23a2ebc8f79f4e
+  metadata.gz: c93432ed686e1f80df9f1d4fa5d33eb38785b02b
+  data.tar.gz: dffe41b0e69376c7669a30b184a76c405e3b2751
 SHA512:
-  metadata.gz: a9d00bfa496efd4a21c47bbc0a613f5fab98f245a3d87d3ca252837ebd9cdafc8fa5a4af2ca6a7c0a62e231d870833f55337ce00959fd8db22894523335063fb
-  data.tar.gz: c73d3f40ea5053b5dbebc54309be0bca063befcc2c6fa371007c393b8ff5840c166ad00969d40b6564fd5888c141a4deaac4265c0f9e1b2f9e37f4ae22ffd32d
+  metadata.gz: d7dae1c53e40a3d2c24d7dc8715a07c7fa41c917b316ed4b33afe3cb13239ea647e977b3bbead6bc42d1c48850d60fb6afec4620f14c552148db055c44fb2eb7
+  data.tar.gz: 1668ab62de7584be9e23d67016560b36c8bda85e9fcd36a9b40f40f421d5e26bf529991eb8cae686418ed55057a6645ffe49a4b75607b13ffeab9cb8d8b31a60

data/README.md

@@ -3,6 +3,10 @@ YourMembership: Ruby SDK for the YourMembership.Com XML API
 
 _This SDK for Version 2.00 of the YourMembership.com API_
 
+[![Gem Version](https://badge.fury.io/rb/your_membership.svg)](http://badge.fury.io/rb/your_membership)
+[![Inline docs](http://inch-ci.org/github/ECHOInternational/your_membership.svg?branch=master)](http://rubydoc.info/gems/your_membership/1.0.0/frames)
+[![Code Climate](https://codeclimate.com/github/ECHOInternational/your_membership/badges/gpa.svg)](https://codeclimate.com/github/ECHOInternational/your_membership)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -80,7 +84,7 @@ The options hash is present any time optional arguments can be passed to a metho
 `YourMembership::Events.all_search` takes one required argument (a session object/key) and up to three optional arguments passed as a hash.
 
 ```RUBY
-session = YourMembership::Session.new
+session = YourMembership::Session.create
 options = {:SearchText => "A string to search for", :PageSize => 5, :StartRecord => 6}
 YourMembership::Events.all_search session, options
 ```
@@ -131,10 +135,10 @@ Sessions can be **generic** (unauthenticated), **authenticated**, or **abandoned
 ##### Examples:
 ```RUBY
 # Generic (unauthenticated) Session
-session = YourMembership::Session.new
+session = YourMembership::Session.create
 
 # Authenticated Session
-auth_session = YourMembership::Session.new 'username', 'password'
+auth_session = YourMembership::Session.create 'username', 'password'
 
 # Sessions can also be authenticated after creation in one of two ways:
 
@@ -164,7 +168,7 @@ member = YourMembership::Member.create_by_authentication 'username', 'password'
 # Members can also be created by passing in an already existing Session instance
 # this is especially useful when Sessions are authenticated through token
 # authentication.
-auth_session = YourMembership::Session.new 'username', 'password'
+auth_session = YourMembership::Session.create 'username', 'password'
 member = YourMembership::Member.create_from_session auth_session
 ```
 _Member objects can be created directly without a bound Session, but there is (as of yet) very little use for this._

data/lib/your_membership/member.rb

@@ -59,7 +59,7 @@ module YourMembership
     # @param [String] password The password in cleartext
     # @return [YourMembership::Member] Returns a new Member object with associated authenticated Session object
     def self.create_by_authentication(username, password)
-      session = YourMembership::Session.new username, password
+      session = YourMembership::Session.create username, password
       create_from_session(session)
     end
 

data/lib/your_membership/sa_members.rb

@@ -169,7 +169,7 @@ module YourMembership
         response = post('/', :body => build_XML_request('Sa.Members.Profile.Create', nil, options))
         response_valid? response
         YourMembership::Sa::Auth.authenticate(
-          YourMembership::Session.new,
+          YourMembership::Session.create,
           profile.data['Username'],
           profile.data['Password']
         )

data/lib/your_membership/session.rb

@@ -14,30 +14,35 @@ module YourMembership
   # * *Abandoned sessions* are no longer usable and are essentially the same as logging out.
   #
   # @example Generic (unauthenticated) Session
-  #  session = YourMembership::Session.new # => <YourMembership::Session>
+  #  session = YourMembership::Session.create # => <YourMembership::Session>
   # @example Authenticated Session
-  #  auth_session = YourMembership::Session.new 'username', 'password' # => <YourMembership::Session>
+  #  auth_session = YourMembership::Session.create 'username', 'password' # => <YourMembership::Session>
   #
   # @attr_reader [String] session_id The unique session identifier provided by the API
   # @attr_reader [String, Nil] user_id The user id of the user bound to the session, if one exists.
   class Session < YourMembership::Base
-    attr_reader :session_id, :user_id
+    attr_reader :session_id, :user_id, :call_id
+
+    # Generates an empty session
+    def initialize(session_id = nil, call_id = 1, user_id = nil)
+      @session_id = session_id
+      @call_id = call_id
+      @user_id = user_id
+    end
 
     # @see https://api.yourmembership.com/reference/2_00/Session_Create.htm
     # @param user_name [String] Constructor takes optional parameters of user_name and password. If supplied then the
     #  session will be automatically authenticated upon instantiation.
     # @param password [String]
-    def initialize(user_name = nil, password = nil)
-      @call_id = 1
-      @user_id = nil
-
-      response = self.class.post('/', :body => self.class.build_XML_request('Session.Create'))
+    def self.create(user_name = nil, password = nil)
+      response = post('/', :body => build_XML_request('Session.Create'))
 
-      if self.class.response_valid? response
-        @session_id = response['YourMembership_Response']['Session.Create']['SessionID']
+      if response_valid? response
+        session = new response['YourMembership_Response']['Session.Create']['SessionID']
       end
 
-      authenticate user_name, password if user_name
+      session.authenticate user_name, password if user_name
+      session
     end
 
     # @return [Integer] Auto Increments ad returns the call_id for the session as required by the YourMembership.com API

data/lib/your_membership/version.rb

@@ -1,3 +1,3 @@
 module YourMembership
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: your_membership
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nate Flood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty