login_radius 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a38dc6be5450d4639073fdfc10aafe6ca6ce3c5
-  data.tar.gz: 74689a0d9bd22acc90e7e1c1e9ae0073c53bbf82
+  metadata.gz: 6b9ff9727e8d0ec474fcf86616bc1061c3116ab6
+  data.tar.gz: fba790fc62a2bab90af335da1323da95ece34ede
 SHA512:
-  metadata.gz: 4997319c001d5f59e575c8000763198079063dc5a6c4e1e639ad3ca0529f17f6c986c4da7ca2a96d02c5108e5241efb24e20c9dd377687624fe60a3817a3c5de
-  data.tar.gz: ff62c2061bfdff0465a9ba2e2c3340b4709f3786552571b7ea3c1541a8b7212af6c98cbbc7922066b83ecef0a0775358f6e274204a69e0ba09faf99680aaa1d4
+  metadata.gz: 476acd90921456e1b9c66c833ab8294c8ce2b52edacd4e7e2413f7b3723e9fbdf41296709ce24a4c84d7cde817c668a69d2ce1abc7874ea48841d7a78bab15e7
+  data.tar.gz: 646fe415604be6fca129a1062821ce849882afb280c59c65f8787cea6f584bb28288b0bab817a410a2449a455b47a5d165814c00e1cdbccb09040c0e58b30ec1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jordan Prince
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# LoginRadius
+
+Ruby wrapper for the LoginRadius API. Get social graph information and send messages using LoginRadius'
+many social network clients!
+
+Optional Asynchronous EventMachine friendly option!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'login_radius'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install login_radius
+
+## Usage
+
+Take a peek:
+
+    @LoginRadius = {
+      :sitename => "<LOGINRADIUS_SITE_NAME>",
+      :appkey => "<LOGINRADIUS_APPKEY>",
+      :appsecret => "<LOGINRADIUS_APPSECRET>",
+      :objectId => "<LOGINRADIUS_OBJECT_ID>"
+    }
+    @user_profile = LoginRadiusRaas::RaasApi.new(@LoginRadius);
+		
+
+### How to get a token and actually make a client
+
+On the LoginRadius website, you are able to enter your own callback URL for your site. You will need
+to setup a route on whatever framework you use, maybe "/callback." Then, get the gem forward(www.example.com)
+and use it to set up a public web address for your localhost server. Then, you can enter the callback on LoginRadius
+as https://example.com/callback, for instance.
+
+Paste their example login stuff onto your index page, and then configuration provider on your LoginRadius site.
+
+Now you're ready to go with testing!
+
+When LoginRadius hits your callback after a user logs in, you'll see parameters like this:
+
+Parameters: {"token"=>"yourtokenhere"}
+
+This token is the token used in the above example. This is what you'll need to get your access token and fetch user's profile from LoginRadius.
+Just paste it into the code above, and you can immediately grab their user profile on the callback,
+login, and grab their contacts.

data/lib/hash.rb

@@ -1,13 +1,12 @@
-class Hash
-  def self.lr_convert_hash_keys(value) #lr_ appended so no method naming conflicts with other gems
-    case value
-      when Array
-        value.map { |v| lr_convert_hash_keys(v) }
-        # or `value.map(&method(:convert_hash_keys))`
-      when Hash
-        Hash[value.map { |k, v| [k.to_s.lr_underscore, lr_convert_hash_keys(v)] }]
-      else
-        value
-     end
-  end
+class Hash
+  def self.lr_convert_hash_keys(value) #lr_ appended so no method naming conflicts with other gems
+    case value
+      when Array
+        value.map { |v| lr_convert_hash_keys(v) }
+      when Hash
+        Hash[value.map { |k, v| [k.to_s.lr_underscore, lr_convert_hash_keys(v)] }]
+      else
+        value
+     end
+  end
 end

data/lib/login_radius/account_api.rb

@@ -0,0 +1,130 @@
+module LoginRadiusRaas
+  module AccountApi
+    #
+    # This API is used to link a user account with a specified providers user account.
+    #
+    # params = {
+    #      :accountid => uid,
+    #      :provider => Provider Name,
+    #      :providerid => Social ID
+    # }
+    #
+    # return {“isPosted”: “true”}
+    #
+    def account_link!(params)
+      api_client("raas/v1/account/link", {}, params);
+    end
+
+    def account_link(params={})
+      account_link!(params)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    #
+    # This API is used to unlink a user account with a specified providers user account.
+    #
+    # params = {
+    #      :accountid => uid,
+    #      :provider => Provider Name,
+    #      :providerid => Social ID
+    # }
+    #
+    # return {“isPosted”: “true”}
+    #
+    def account_unlink!(params)
+      api_client("raas/v1/account/unlink", {}, params);
+    end
+
+    def account_unlink(params={})
+      account_unlink!(params)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+    #
+    # This API is used to delete a user account
+    #
+    # accountid => uid;
+    #
+    # return {“isPosted”: “true”}
+    #
+      def account_delete!(accountid)
+      api_client("raas/v1/account/delete", {:accountid=>accountid});
+    end
+
+    def account_delete(accountid)
+      account_delete!(accountid)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+    #
+    # This API is used to changed username for a user account
+    #
+    # accountid = uid
+    # currentusername = currentusername
+    # newusername = newusername
+    #
+    # return {“isPosted”: “true”}
+    #
+      def account_change_username!(uid,currentusername,newusername)
+      api_client("raas/v1/account/changeusername", {:accountid=>uid},{:currentusername=>currentusername,:newusername=>newusername}, 'json');
+    end
+
+    def account_change_username(uid,currentusername,newusername)
+      account_change_username!(uid,currentusername,newusername)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+    #
+    # This API is used to set username for a user account
+    #
+    # accountid = uid
+    # username = username
+    #
+    # return {“isPosted”: “true”}
+    #
+    def account_set_username!(uid,username)
+      api_client("raas/v1/account/setusername", {:accountid=>uid},{:newusername=>username}, 'json');
+    end
+
+    def account_set_username(uid,username)
+      account_set_username!(uid,username)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+    #
+    # This API is used to check username for a user account
+    #
+    # username = username
+    #
+    # return {“isExist”: “true”}
+    #
+      def account_check_username!(username)
+      api_client("raas/client/auth/checkusername",{:username=>username});
+    end
+
+    def account_check_username(username)
+      account_check_username!(username)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+
+    
+    #
+    # This API is used to retrieve all of the profile data from each of the linked social provider accounts associated with the account. For ex: A user has linked facebook and google account then this api will retrieve both profile data.
+    #
+    # uid = xxxxxxxxxx;
+    #
+    # return Array of user profile
+    #
+    def account_get_profiles_by_uid!(uid)
+      api_client("raas/v1/account", {:accountid=>uid});
+    end
+
+    def account_get_profiles_by_uid(uid)
+      account_get_profiles_by_uid!(uid)
+    rescue LoginRadiusRaas::Exception => e
+      false
+      end
+  end
+end

data/lib/login_radius/basic_api.rb

@@ -0,0 +1,389 @@
+module LoginRadiusRaas
+  module BasicApi
+    #
+    # LoginRadius function - Fetch LoginRadius access token after authentication. It will be valid for the specific duration of time specified in the response.
+    # @param string LoginRadius API token
+    #
+    # @return mixed string|object LoginRadius access token.
+    #
+    #
+    def get_access_token!(token)
+      return api_client("api/v2/access_token", {:token=>token,:secret=>appsecret});
+    end
+
+    def get_access_token(token)
+      return get_access_token!(token)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To fetch social profile data from the user's social account after authentication. The social profile will be retrieved via oAuth and OpenID protocols. The data is normalized into LoginRadius' standard data format.
+    #
+    # @param string accessToken LoginRadius access token
+    # @param boolean raw If true, raw data is fetched
+    #
+    # @return object User profile data.
+    #
+    def get_user_profile!(accessToken, raw)
+      return api_client("api/v2/userprofile" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_user_profile(accessToken, raw = false)
+      return get_user_profile!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get the Albums data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string accessToken LoginRadius access token
+    # @param boolean raw If true, raw data is fetched
+    #
+    # @return object User's albums data.
+    #
+    #
+    def get_albums!(accessToken, raw)
+      return api_client("api/v2/album" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_albums(accessToken, raw = false)
+      return get_albums!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To fetch photo data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string accessToken LoginRadius access token
+    # @param string albumId ID of the album to fetch photos from
+    # @param boolean raw If true, raw data is fetched
+    #
+    # @return object User's photo data.
+    #
+    def get_photos!(accessToken, albumId, raw)
+      return api_client("api/v2/photo" + get_row_data(raw), {:access_token=>accessToken,:albumid=>albumId});
+    end
+
+    def get_photos(accessToken, albumId, raw = false)
+      return get_photos!(accessToken, albumId, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To fetch check-ins data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string accessToken LoginRadius access token
+    # @param boolean raw If true, raw data is fetched
+    #
+    # @return object User's check-ins.
+    #
+    #
+    def get_checkins!(accessToken, raw)
+      return api_client("api/v2/checkin" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_checkins(accessToken, raw = false)
+      return get_checkins!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To fetch user's audio files data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string accessToken LoginRadius access token
+    # @param boolean raw If true, raw data is fetched
+    #
+    # @return object User's audio files data.
+    #
+    #
+    def get_audio!(accessToken, raw)
+      return api_client("api/v2/audio" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_audio(accessToken, raw = false)
+      return get_audio!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - Post messages to the user's contacts. After using the Contact API, you can send messages to the retrieved contacts.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param string $to Social ID of the receiver
+    # @param string $subject Subject of the message
+    # @param string $message Message
+    #
+    # @return bool True on success, false otherwise
+    #
+    #
+    def send_message!(accessToken, to, subject, message)
+      param = {
+        :access_token => accessToken,
+        :to => to,
+        :subject => subject,
+        :message => message
+      }
+      return api_client("api/v2/message", param,{});
+    end
+
+    def send_message(accessToken, to, subject, message)
+      return send_message!(accessToken, to, subject, message)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To fetch user's contacts/friends/connections data from the user's social account. The data will normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param integer $nextCursor Offset to start fetching contacts from
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object User's contacts/friends/followers.
+    #
+    #
+    def get_contacts!(accessToken, nextCursor, raw)
+      return api_client("api/v2/contact" + get_row_data(raw), {:access_token=>accessToken,:nextcursor=>nextCursor});
+    end
+
+    def get_contacts(accessToken, nextCursor = '0', raw = false)
+      return get_contacts!(accessToken, nextCursor, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get mention data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object User's twitter mentions.
+    #
+    def get_mentions!(accessToken, raw)
+      return api_client("api/v2/mention" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_mentions(accessToken, raw = false)
+      return get_mentions!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To fetch information of the people, user is following on Twitter.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object Information of the people, user is following.
+    #
+    def get_following!(accessToken, raw)
+      return api_client("api/v2/following" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_following(accessToken, raw = false)
+      return get_following!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get the event data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object User's event data.
+    #
+    def get_events!(accessToken, raw)
+      return api_client("api/v2/event" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_events(accessToken, raw = false)
+      return get_events!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get posted messages from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object User's posted messages.
+    #
+    def get_posts!(accessToken, raw)
+      return api_client("api/v2/post" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_posts(accessToken, raw = false)
+      return get_posts!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get the followed company's data in the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object Companies followed by user.
+    #
+    def get_followed_companies!(accessToken, raw)
+      return api_client("api/v2/company" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_followed_companies(accessToken, raw = false)
+      return get_followed_companies!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get group data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object Group data.
+    #
+    def get_groups!(accessToken, raw)
+      return api_client("api/v2/group" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_groups(accessToken, raw = false)
+      return get_groups!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get the status messages from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object Status messages.
+    #
+    def get_status!(accessToken, raw)
+      return api_client("api/v2/status" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_status(accessToken, raw = false)
+      return get_status!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To update the status on the user's wall.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param string $title Title for status message (Optional).
+    # @param string $url A web link of the status message (Optional).
+    # @param string $imageurl An image URL of the status message (Optional).
+    # @param string $status The status message text (Required).
+    # @param string $caption Caption of the status message (Optional).
+    # @param string $description Description of the status message (Optional).
+    #
+    # @return boolean Returns true if successful, false otherwise.
+    #
+    def post_status!(accessToken, title, url, imageurl, status, caption, description)
+      param = {
+        :access_token => accessToken,
+        :title => title,
+        :url => url,
+        :imageurl => imageurl,
+        :status => status,
+        :caption => caption,
+        :description => description
+      }
+      return api_client("api/v2/status", param, {});
+    end
+
+    def post_status(accessToken, title, url, imageurl, status, caption, description)
+      return post_status!(accessToken, title, url, imageurl, status, caption, description)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get videos data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object Videos data.
+    #
+    def get_videos!(accessToken, raw)
+      return api_client("api/v2/video" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_videos(accessToken, raw = false)
+      return get_videos!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get likes data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object likes data.
+    #
+    def get_likes!(accessToken, raw)
+      return api_client("api/v2/like" + get_row_data(raw), {:access_token=>accessToken});
+    end
+
+    def get_likes(accessToken, raw = false)
+      return get_likes!(accessToken, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To get the page data from the user's social account. The data will be normalized into LoginRadius' data format.
+    #
+    # @param string $accessToken LoginRadius access token
+    # @param string $pageName Page name
+    # @param boolean $raw If true, raw data is fetched
+    #
+    # @return object Page data.
+    #
+    def get_pages!(accessToken, pageName, raw)
+      return api_client("api/v2/page" + get_row_data(raw), {:access_token=>accessToken,:pagename=>pageName});
+    end
+
+    def get_pages(accessToken, pageName, raw = false)
+      return get_pages!(accessToken, pageName, raw)
+    rescue LoginRadiusRaas::Exception => e
+      return false
+      end
+
+    #
+    # LoginRadius function - To fetch data from the LoginRadius Raw API URL.
+    #
+    # @param boolean raw If true, raw data is fetched
+    #
+    # @return string Data to add in API URL.
+    #
+    def get_row_data(raw)
+      if raw
+        return '/raw';
+      else
+        return '';
+      end
+    end
+  end
+end