rgigya 1.0.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p125@rgigya --create

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "jeweler", "~> 1.8.4"
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.3.4"
+  gem "rspec"
+end
+
+
+
+gem 'httparty', "~> 0.11.0"

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    bourne (1.4.0)
+      mocha (~> 0.13.2)
+    diff-lcs (1.2.3)
+    git (1.2.5)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    metaclass (0.0.1)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.2)
+    multi_xml (0.5.3)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    shoulda (3.4.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (~> 1.0, >= 1.4.1)
+    shoulda-context (1.1.0)
+    shoulda-matchers (1.5.6)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3.4)
+  httparty (~> 0.11.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Scott
+
+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.rdoc

@@ -0,0 +1,135 @@
+= RGigya
+
+RGigya is an sdk wrapper around the Gigya Rest Api.  
+
+== Install
+
+  gem install rgigya
+
+== Getting started
+
+Please read the documentation at gigya for best practices.  http://developers.gigya.com/037_API_reference.  You may need to create a developers account to access the documentation.
+
+=== Get your api key and secret.
+
+You will need to setup your own dev site on the gigya platform for testing.  
+
+* Go to https://platform.gigya.com/login.aspx to login.
+* Once you have logged into the platform. Click "add site"
+* Enter a domain and description and click add site
+* Remember the api key and secret for later
+
+=== Without Rails (Standalone)
+
+  require 'RGigya'
+
+  GIGYA_API_KEY = "<add api key here>"
+  GIGYA_API_SECRET = "<add api secret here>"
+
+  RGigya.socialize_notifyLogin({:siteUID => '1'})
+
+
+=== With Rails
+
+Edit your config/environments/development.rb file and add the following constants
+
+
+  GIGYA_API_KEY = "<add api key here>"
+  GIGYA_API_SECRET = "<add api secret here>"
+
+Then add your api calls in your controllers, models, libraries, etc.
+
+  RGigya.socialize_notifyLogin({:siteUID => '1'})
+
+
+== Examples
+
+=== socialize.notifyLogin
+
+http://developers.gigya.com/037_API_reference/010_Socialize/socialize.notifyLogin
+
+  userInfo = {
+    'nickname' => 'Gigems', 
+    'email' => 'ralph@cloudspace.com',
+    'firstName' => 'Ralph', 
+    'lastName' => 'Masterson'
+  }
+
+  RGigya.socialize_notifyLogin({:siteUID => '1', :userInfo => userInfo.to_json} )
+
+=== gm.notifyAction
+
+http://developers.gigya.com/037_API_reference/040_GM/gm.notifyAction
+
+  RGigya.gm_notifyAction(:uid => '1',:action => 'comment_upvote')
+
+=== comments.flagComment
+
+http://developers.gigya.com/037_API_reference/030_Comments/comments.flagComment
+
+  gigya_params = {
+    :commentID => params[:commentID],
+    :categoryID => params[:categoryID],
+    :streamID => params[:streamID]
+  }
+
+  RGigya.comments_flagComment(gigya_params)
+  
+== Rspec Tests
+
+We have included rspec unit tests.
+
+=== Configuration
+
+Edit spec/spec_helper.rb
+
+  Replace <add api key here> with your api key
+  Replace <add api secret here> with your api secret
+
+
+=== Running tests
+
+  cd <root of the project>
+  rspec rgigya_spec.rb
+  
+  
+== Rails dummy site
+
+We have included a rails dummy site to give you an idea of how to integrate the gem within rails.  It just peforms a simple login.
+
+=== Configuration
+
+* Edit app/views/layouts/application.html.erb
+  * replace <add api key here> with your api key.  You do NOT need a secret on this page.
+  * replace the callback to be appropriate to your dev site.
+    * In my case I added dev.rgigya.com to my hosts file and pointed it to localhost (127.0.0.1)
+    * I then made the callback http://dev.rgigya.com/welcome.html in application.html.erb
+* Edit config/environments/development.rb and add the following constants
+  * GIGYA_API_KEY = "<add api key here>"
+  * GIGYA_API_SECRET = "<add api secret here>"
+
+=== Running the rails app
+
+  cd test/dummy
+  bundle
+  sudo rails s -p80
+  
+== New Feature Ideas
+
+* Rake tasks that help manage the data in gigya such as removing test users.
+
+== Contributing to RGigya
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Cloudspace. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rgigya"
+  gem.homepage = "http://github.com/scottsampson/rgigya"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby Wrapper/SDK for the Gigya api}
+  gem.description = %Q{This is a ruby SDK for the Gigya api.}
+  gem.email = "scott@cloudspace.com"
+  gem.authors = ["Scott Sampson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rgigya #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/lib/rgigya.rb

@@ -0,0 +1,196 @@
+require 'json'
+require 'httparty'
+require 'CGI'
+
+#
+# Quick sdk for the gigya api
+#
+# You can reference api calls at http://developers.gigya.com/037_API_reference
+#
+# Example call
+# RGigya.socialize_setStatus(:uid => @user.id,:status => 'hello')
+#
+# We split the method name by the underscore and then map 
+# the first token to the correct url using the @@urls class variable
+# The example above calls the url https://socialize.gigya.com/socialize.setStatus
+#
+# @author Scott Sampson
+
+
+#
+# Constants to be used for the gigya key and secret.  
+# These should be commented out and set in your environments for your rails project.
+# Uncomment below for testing without rails
+#
+# GIGYA_API_KEY = "12345"
+# GIGYA_API_SECRET = "12345"
+
+
+class RGigya
+  
+  # Mapping to different urls based on api groupings
+  @@urls = {
+    socialize: "https://socialize-api.gigya.com",
+    gm: "https://gm.gigya.com",
+    comments: "https://comments.gigya.com",
+    accounts: "https://accounts.gigya.com",
+    reports: "https://reports.gigya.com",
+    chat: "https://chat.gigya.com",
+    ds: "https://ds.gigya.com"
+  }
+  
+  #
+  # Custom Exceptions so we know it came from the library
+  # When in use please namespace them appropriately RGigya::ResponseError for readability
+  #
+  exceptions = %w[ UIDParamIsNil SiteUIDParamIsNil ResponseError BadParamsOrMethodName ErrorCodeReturned  ]  
+  exceptions.each { |e| const_set(e, Class.new(StandardError)) }
+  RGigya::JSONParseError = Class.new(JSON::ParserError)
+  
+  class << self
+    
+    #
+    # Adds the required params for all api calls
+    # 
+    def required_parameters
+      params =  "apiKey=#{CGI.escape(GIGYA_API_KEY)}"
+      params += "&secret=#{CGI.escape(GIGYA_API_SECRET)}"
+      params += "&format=json"
+    end
+    
+    #
+    # builds the url to be sent to the api
+    #
+    # @param [String] method The method name to be called in the gigya api
+    # @param [Hash] options Hash of key value pairs passed to the gigya api
+    #
+    # @return [String] the full url to be sent to the api
+    #
+    # @author Scott Sampson
+    def build_url(method, options = {})
+      if options && options.has_key?(:uid) && options[:uid].nil?
+        raise RGigya::UIDParamIsNil, ""
+      end
+      
+      if options && options.has_key?(:siteUID) && options[:siteUID].nil?
+        raise RGigya::SiteUIDParamIsNil, ""
+      end
+
+      method_type,method_name = method.split(".")
+      url = "#{@@urls[method_type.to_sym]}/#{method}?#{required_parameters}"
+      if(options)
+        options.each do |key,value|
+          url += "&#{key}=#{CGI.escape(value.to_s)}"
+        end
+      end
+      url
+    end
+    
+    #
+    # sends the https call to gigya and parses the result
+    # 
+    # @param [String] method The method name to be called in the gigya api
+    # @param [Hash] options Hash of key value pairs passed to the gigya api
+    #
+    # @return [Hash] hash of the api results in key/value format
+    #
+    # @author Scott Sampson
+    def parse_results(method, options = {})
+      # options = {} if options.is_a?(String) && options.blank?
+      begin
+        response = HTTParty.get(build_url(method, options),{:timeout => 10})
+      rescue SocketError,Timeout::Error => e 
+        raise RGigya::ResponseError, e.message
+      end
+      return false if response.nil? || response.body == "Bad Request"
+
+      begin
+        doc = JSON(response.body)
+      rescue JSON::ParserError => e
+        raise RGigya::JSONParseError, e.message
+      end
+      doc
+    end
+    
+    #
+    # Error handling of the results
+    # 
+    # @param [String]  The method name to be called in the gigya api
+    # @param [Hash] results Hash of key value pairs returned by the results
+    #
+    # @return [String] hash of a successful api call
+    # 
+    # TODO:  Shouldn't fail so hard.  If there is a temporary connectivity problem we should fail more gracefully.
+    # You can find a list of response codes at http://developers.gigya.com/037_API_reference/zz_Response_Codes_and_Errors
+    #
+    # @author Scott Sampson
+    def check_for_errors(results)
+      case results['errorCode'].to_s
+        when '0'
+          return results
+        when '400124'
+          #Limit Reached error - don't fail so bad
+        when '400002'
+          raise RGigya::BadParamsOrMethodName, results['errorDetails']
+        else 
+          log("RGigya returned Error code #{results['errorCode']}.\n\nError Message: #{results['errorMessage']}\n\nError Details: #{results['errorDetails']}")
+          raise RGigya::ErrorCodeReturned, "returned Error code #{results['errorCode']}: #{results['errorMessage']}"
+      end
+    end
+    
+    ##
+    # Override method_missing so we don't have to write all the dang methods
+    #
+    # @param [Symbol] sym The method symbol
+    # @param [*Array] args The splatted array of method arguments passed in
+    #
+    # @author Scott Sampson
+    def method_missing(sym, *args)
+      
+      method = sym.to_s.gsub("_",".")
+      method_type,method_name = method.split(".")
+      if(@@urls.has_key?(method_type.to_sym)) 
+        results = parse_results(method, args.first)
+      else 
+        results = false
+      end
+      
+      if results
+        return check_for_errors(results)
+      else 
+        super
+      end
+    end
+    
+    
+    ##
+    # Override respond_to? We can't really give an accurate return here
+    # I am only allowing those methods that start with those methods in the @urls hash
+    #
+    # @param [Symbol] sym The method symbol
+    # @param [Boolean] include_private Whether you want to include private or not. 
+    #
+    # @author Scott Sampson
+    def respond_to?(sym, include_private = false)
+      method = sym.to_s.gsub("_",".")
+      method_type,method_name = method.split(".")
+      return @@urls.has_key?(method_type.to_sym)
+    end
+    
+    
+        
+    ##
+    # Custom log method, if we are in rails we should log any errors for debugging purposes
+    #
+    # @param [String] log_str string to log
+    #
+    # @author Scott Sampson
+    def log(log_str)
+      if Object.const_defined?('Rails')
+        Rails.logger.info(log_str)
+      else
+        puts log_str
+      end
+    end
+  end
+end

data/rgigya.gemspec

@@ -0,0 +1,118 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rgigya"
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Sampson"]
+  s.date = "2013-04-17"
+  s.description = "This is a ruby SDK for the Gigya api."
+  s.email = "scott@cloudspace.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rgigya.rb",
+    "rgigya.gemspec",
+    "spec/helpers.rb",
+    "spec/rgigya_spec.rb",
+    "spec/spec_helper.rb",
+    "test/dummy/Gemfile",
+    "test/dummy/Gemfile.lock",
+    "test/dummy/README.rdoc",
+    "test/dummy/Rakefile",
+    "test/dummy/app/assets/images/rails.png",
+    "test/dummy/app/assets/javascripts/application.js",
+    "test/dummy/app/assets/stylesheets/application.css",
+    "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/controllers/welcome_controller.rb",
+    "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/mailers/.gitkeep",
+    "test/dummy/app/models/.gitkeep",
+    "test/dummy/app/views/layouts/application.html.erb",
+    "test/dummy/app/views/welcome/index.html",
+    "test/dummy/app/views/welcome/index.html.erb",
+    "test/dummy/config.ru",
+    "test/dummy/config/application.rb",
+    "test/dummy/config/boot.rb",
+    "test/dummy/config/database.yml",
+    "test/dummy/config/environment.rb",
+    "test/dummy/config/environments/development.rb",
+    "test/dummy/config/environments/production.rb",
+    "test/dummy/config/environments/test.rb",
+    "test/dummy/config/initializers/backtrace_silencers.rb",
+    "test/dummy/config/initializers/inflections.rb",
+    "test/dummy/config/initializers/mime_types.rb",
+    "test/dummy/config/initializers/secret_token.rb",
+    "test/dummy/config/initializers/session_store.rb",
+    "test/dummy/config/initializers/wrap_parameters.rb",
+    "test/dummy/config/locales/en.yml",
+    "test/dummy/config/routes.rb",
+    "test/dummy/db/development.sqlite3",
+    "test/dummy/db/seeds.rb",
+    "test/dummy/lib/assets/.gitkeep",
+    "test/dummy/lib/tasks/.gitkeep",
+    "test/dummy/log/.gitkeep",
+    "test/dummy/log/development.log",
+    "test/dummy/public/404.html",
+    "test/dummy/public/422.html",
+    "test/dummy/public/500.html",
+    "test/dummy/public/favicon.ico",
+    "test/dummy/public/robots.txt",
+    "test/dummy/script/rails",
+    "test/dummy/test/fixtures/.gitkeep",
+    "test/dummy/test/functional/.gitkeep",
+    "test/dummy/test/integration/.gitkeep",
+    "test/dummy/test/performance/browsing_test.rb",
+    "test/dummy/test/test_helper.rb",
+    "test/dummy/test/unit/.gitkeep",
+    "test/dummy/vendor/assets/javascripts/.gitkeep",
+    "test/dummy/vendor/assets/stylesheets/.gitkeep",
+    "test/dummy/vendor/plugins/.gitkeep"
+  ]
+  s.homepage = "http://github.com/scottsampson/rgigya"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "Ruby Wrapper/SDK for the Gigya api"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.11.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3.4"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, ["~> 0.11.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.3.4"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, ["~> 0.11.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.3.4"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/spec/helpers.rb

@@ -0,0 +1,8 @@
+module Helpers
+  def get_uid
+    response = RGigya.socialize_notifyLogin({
+      :siteUID => '1'
+    })
+    return response['UID']
+  end
+end