nitroapi 0.0.5 → 0.0.7

data/.gitignore

@@ -0,0 +1,51 @@
+examples/my*
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+keys.json
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/Gemfile

@@ -1,20 +1,8 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-# Please keep me alphabetized!
-gem 'activesupport'
-gem 'json'
-
-# Please keep me alphabetized!
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
-end
+# Specify your gem's dependencies in nitroapi.gemspec
+gemspec
 
 group :test do
   gem "webmock"
-end
+end

data/Gemfile.lock

@@ -1,18 +1,22 @@
+PATH
+  remote: .
+  specs:
+    nitroapi (0.0.6)
+      activesupport
+      json
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (3.0.9)
-    addressable (2.2.6)
-    crack (0.1.8)
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    json (1.5.3)
-    rake (0.8.7)
-    rcov (0.9.9)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    json (1.7.5)
+    multi_json (1.4.0)
     rspec (2.3.0)
       rspec-core (~> 2.3.0)
       rspec-expectations (~> 2.3.0)
@@ -21,18 +25,20 @@ GEM
     rspec-expectations (2.3.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.3.0)
-    webmock (1.6.4)
-      addressable (~> 2.2, > 2.2.5)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
       crack (>= 0.1.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
-  bundler (~> 1.0.0)
-  jeweler (~> 1.6.4)
-  json
-  rcov
+  bundler (~> 1.2.2)
+  nitroapi!
   rspec (~> 2.3.0)
+  simplecov (~> 0.7.1)
   webmock

data/README.md

@@ -31,18 +31,24 @@ nitro.log_action "Video_Watch"
 
 ```ruby
 nitro.action_history "Video_Watch"
-nitro.challenge_progress "Watch 10 Videos"
+nitro.challenge_progress :challenge => "Watch 10 Videos"
 ```
 
 Installing
 ----------
-add to your Gemfile
+ 1) add to your Gemfile
+
 ```
-gem 'nitroapi', :git => 'git://github.com/KeasInc/nitroapi.git'
+gem 'nitroapi'
 ```
 
+ 2) Create a keys.json file with your api_key and secret (see keys.json.example file)
+
 Change Log
 ----------
+0.0.6
+* add rules descriptions in challenge_progress call
+
 0.0.5
 
 #### Bug fixes:

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'bundler'
+require "bundler/gem_tasks"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -11,19 +12,6 @@ rescue Bundler::BundlerError => e
 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 = "nitroapi"
-  gem.homepage = "http://github.com/Keasinc/nitroapi"
-  gem.license = "MIT"
-  gem.summary = "Api client for Bunchball's Nitro"
-  gem.description = "Api client for Bunchball's Nitro. http://www.bunchball.com/nitro/"
-  gem.authors = ["Gilad Buchman"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|

data/lib/nitro_api.rb

@@ -2,10 +2,12 @@ require 'json'
 require 'digest/md5'
 require 'net/http'
 require 'nitro_api/challenge'
+require 'nitro_api/rule'
+require 'nitro_api/batch_calls'
+require 'nitro_api/user_calls'
+require 'nitro_api/site_calls'
 
 module NitroApi
-  HOST = "http://sandbox.bunchball.net/nitro/"
-  ACCEPT = "json?"
 
   class NitroError < StandardError
     attr_accessor :code
@@ -16,130 +18,148 @@ module NitroApi
   end
 
   class NitroApi
-    attr_accessor :session
 
+    include BatchCalls
+    include SiteCalls
+    include UserCalls
+
+    attr_accessor :protocol, :host, :accepts, :session
+
+    # Initialize an instance
+    # user_id - The id for the user in the nitro system
+    # api_key - The API key for your Bunchball account
+    # secret - The secret for your Bunchball account
     def initialize (user_id, api_key, secret)
-      # Required Parameters
       @secret = secret
       @api_key = api_key
       @user = user_id
+      @batch = nil
+
+      self.protocol = 'https'
+      self.host = 'sandbox.bunchball.net'
+      self.accepts = 'json'
+    end
+
+    # Start a batch call to the nitro API. Uses the "batch.run" method defined
+    # here: https://bunchballnet-main.pbworks.com/w/page/53132313/batch_run
+    # returns - false if a batch is already being composed, true otherwise
+    def start_batch
+      if @batch.nil?
+        @batch = []
+        return true
+      end
+
+      return false
+    end
+
+    # Start a batch call to the nitro API. Uses the "batch.run" method defined
+    # here: https://bunchballnet-main.pbworks.com/w/page/53132313/batch_run
+    # If a batch is already being composed, an error will be raised.
+    def start_batch!
+      if not start_batch
+        raise NitroError.new, "A batch is already being composed."
+      end
+    end
+
+    # Run the batch job. Requires that the 'start_batch' method has been called first.
+    def run_batch
+      make_run_batch_call
+    end
+
+    # Cancel the batch job. It clears out the any accumulated calls that have
+    # been made since first calling start_batch
+    def cancel_batch
+      @batch = nil
     end
 
     #  Method for constructing a signature
-    def sign
-      time = Time.now.utc.to_i.to_s
+    def sign(time)
       unencrypted_signature = @api_key + @secret + time + @user.to_s
       to_digest = unencrypted_signature + unencrypted_signature.length.to_s
       return Digest::MD5.hexdigest(to_digest)
     end
 
+    # Login the user to the nitro system
     def login
-      params = {
-        :sig => sign,
-        :ts => Time.now.utc.to_i.to_s,
-        :apiKey => @api_key,
-        :userId => @user,
-        :method => 'user.login'
-      }
-      response = make_call(params)
-      @session = response["Login"]["sessionKey"]
-    end
-
-    def log_action(actions, opts={})
-      value = opts.delete(:value)
-      user_id = opts.delete(:other_user)
-      params = {
-        :tags => actions.is_a?(Array) ? actions.join(",") : actions,
-        :sessionKey => @session,
-        :method => 'user.logAction'
-      }
-      params[:value] = value.to_s if value && !value.to_s.empty?
-      params[:userId] = user_id if user_id && !user_id.to_s.empty
-      make_call(params)
-    end
-
-    def challenge_progress(opts={})
-      params = {
-        :sessionKey => @session,
-        :method => 'user.getChallengeProgress'
-      }
-      challenge = opts[:challenge]
-      params['challengeName'] = challenge if challenge and !challenge.to_s.empty?
-      params['showOnlyTrophies'] = opts.delete(:trophies_only) || false
-      params['folder'] = opts.delete(:folder) if opts.has_key?(:folder)
-
-      response = make_call(params)
-
-      if valid_response?(response['challenges'])
-        items = ensure_array(response['challenges']['Challenge'])
-        items.reduce([]) do |challenges, item|
-          challenge = Challenge.new
-          challenge.name = item["name"]
-          challenge.description = item["description"]
-          challenge.full_url = item["fullUrl"]
-          challenge.thumb_url = item["thumbUrl"]
-          challenge.completed = item["completionCount"].to_i
-
-          challenges<< challenge
-        end
-      end
+      make_login_call
+    end
+
+    # Log actions to the nitro system
+    # @param [String, Array[String]] actions The (list of) action tag(s) to log
+    # @param [Hash] opts The options. They are:
+    #                    :value - the value to send
+    #                    :other_user - the ID of the user to which the action should be applied
+    #                    :session_key - the session key to use for this call
+    def log_action actions, opts={}
+      make_log_action_call actions, opts
     end
 
-    def award_challenge(challenge)
-      params = {
-        :sessionKey => @session,
-        :userId => @user,
-        :method => 'user.awardChallenge',
-        :challenge => challenge
-      }
-      make_call(params)
+    def challenge_progress opts={}
+      make_challenge_progress_call opts
+    end
+
+    def award_challenge challenge
+      make_award_challenge_call challenge
     end
 
     def action_history actions=[]
-      params = {
-        :sessionKey => @session,
-        :method => 'user.getActionHistory'
-      }
-      if actions && !actions.empty?
-        params[:tags] = actions.is_a?(Array) ? actions.join(",") : actions
-      end
-      response = make_call(params)
-      if valid_response?(response['ActionHistoryRecord'])
-        items = ensure_array(response['ActionHistoryRecord']['ActionHistoryItem'])
-        items.reduce([]) do
-          |history, item|
-          history<< {:tags => item['tags'],
-            :ts => Time.at(item['ts'].to_i),
-            :value => item['value'].to_i
-          }
-        end
-      else
-        []
-      end
+      make_action_history_call actions
     end
 
     def join_group group
-      params = {
-        :sessionKey => @session,
-        :method => 'user.joinGroup',
-        :groupName => group
-      }
-      make_call(params)
+      make_join_group_call group
+    end
+
+    # Get the points for a user.
+    # @param [Hash] opts The list of options. The keys in the list are the
+    #        snake_case versions names of the parameters to the getPointsBalance
+    #        API call as defined here:
+    #        https://bunchballnet-main.pbworks.com/w/page/53132548/user_getPointsBalance
+    def get_points_balance opts={}
+      make_get_points_balance_call opts
+    end
+
+    # Get the list of point leaders for the specified options.
+    # opts - The list of options. The keys in the list are the snake_case
+    #        versions names of the parameters to the getPointsLeaders API call
+    #        as defined here:
+    #        https://bunchballnet-main.pbworks.com/w/page/53132408/site_getPointsLeaders
+    def get_points_leaders opts
+      make_points_leaders_call opts
+    end
+
+    def base_url
+      "#{self.protocol}://#{self.host}/nitro/#{self.accepts}"
     end
 
     private
 
-    def valid_response?(obj)
+    def valid_response? obj
       obj.is_a?(Array) || obj.is_a?(Hash)
     end
 
-    def ensure_array(items)
+    def ensure_array items
       items.is_a?(Array) ? items : [items]
     end
 
-    def make_call(params)
-      request = HOST + ACCEPT + to_query(params)
-      data = Net::HTTP.get(URI.parse(request))
+    def make_call params, method=:get
+      if @batch.nil?
+        return really_make_call params, method
+      else
+        @batch << { params: params, method: method }
+        nil
+      end
+    end
+
+    def really_make_call params, method
+      if :get == method
+        request = "#{base_url}?#{to_query(params)}"
+        data = Net::HTTP.get(URI.parse(request))
+      elsif :post == method
+        data = Net::HTTP.post_form(URI.parse(base_url), params)
+        data = data.body
+      end
+
       json = JSON.parse(data)
       response = json["Nitro"]
       error = response["Error"]