prooflink_connect 0.0.23 → 0.0.24

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: 4a4386f433dff015a680394626c9240863408d2f
+  metadata.gz: 83982e69932ae141627d9fec1ea9a2bbfd28a11b
+SHA512: 
+  data.tar.gz: c5644c633b8db81086283682629a85c33afd9a2b2502ee4ff17da6d2c3be03acd743523154be77ceffd9a8846421714d5f8b8c2df266efdf58e979e84459d7b6
+  metadata.gz: 45d9a5c894cf91566b7b3d5732c3a7acdd42968b16d579f3b37c67b5d7aef587477756a9c488bd64f4af2a1499042242218a82ed0bdaccffd64d5ce6ef679692

data/Gemfile

@@ -1,4 +1,5 @@
-source :gemcutter
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in prooflink_connect.gemspec
 gemspec
+

data/README.md

@@ -1,4 +1,4 @@
-# Prooflink Connect [![Build Status](http://travis-ci.org/prooflink/prooflink_connect.png)](http://travis-ci.org/prooflink/prooflink_connect)
+# Prooflink Connect [![Build Status](https://travis-ci.org/prooflink/prooflink_connect.png)](http://travis-ci.org/prooflink/prooflink_connect)
 
 =================
 

data/lib/prooflink_connect.rb

@@ -52,4 +52,8 @@ module ProoflinkConnect
     html = "<iframe src='#{frame_url}' style='width: #{options[:width]}; height: #{options[:height]}; border: 0; display: block;' frameborder='0' allowTransparency='true'></iframe>"
     html.respond_to?(:html_safe) ? html.html_safe : html
   end
+
+  def self.track_activity(identifier, user, options = {})
+    Activity.track(identifier, user, options)
+  end
 end

data/lib/prooflink_connect/activity.rb

@@ -2,34 +2,60 @@ require 'oauth2'
 
 module ProoflinkConnect
   class Activity
+    def self.track(identifier, user, options = {})
+      return if !perform_request?
 
-    # POST /api/v2/activities
-    # parameters:
-    # - activity (required) => {:activity_type => {:identifier => "some_identifier", :name => "Some name", :value => "1"}}
-    # - user => {:email => "foo@bar.com", :first_name => "Foo", :last_name => "Bar"} [for new user]
-    # - user_token => "123-456-789" [for existing user]
-    # - extra_info (optional) => {} [extra custom info you like to pass to activity]
+      activity = build_request(identifier, user, options)
+      response = access_token.post('api/v2/activities', :body => {:activity => activity})
+      MultiJson.decode(response.body)
+    rescue OAuth2::Error => error
+      MultiJson.decode(error.response.body)
+    end
+
+    def self.log(params)
+      warn "Activity.log() is deprecated. Please use Activity.track() instead."
 
-    # SAMPLE:
+      response = access_token.post('api/v2/activities', :body => {:activity => params})
+      MultiJson.decode(response.body)
+    rescue OAuth2::Error => error
+      MultiJson.decode(error.response.body)
+    end
 
-    # ProoflinkConnect::Activity.log({
-    #     activity_type: {identifier: 'some_identifier', name: 'some_name', value: '1'},
-    #     user: {first_name: 'jon', last_name: 'doe', email: 'jon@doe.com', identity_provider: 'prooflink'},
-    #     extra_info: {your_id: '1234'}
-    # })
+    private
 
-    def self.log(params)
-      oauth_access_token = ProoflinkConnect.config.oauth_access_token
-      client             = OAuth2::Client.new(nil, nil, {:site => ProoflinkConnect.config.base_uri})
-      access_token       = OAuth2::AccessToken.new(client, oauth_access_token, :header_format => "OAuth %s")
+    def self.build_request(identifier, user, options)
+      activity = {:activity_type => {:identifier => identifier}}
+      activity[:activity_type][:name] = options[:activity_name] if options[:activity_name]
+      activity[:activity_type][:value] = options[:activity_value] if options[:activity_value]
+      activity[:extra_info] = options[:extra_info] if options[:extra_info]
+      activity[:user] = {:identity_provider => 'prooflink'}
+
+      # In case of a new user that has no identifier yet
+      if user.is_a?(Hash)
+        activity[:user].merge!(user)
+      else
+        activity[:user][:identifier] = user
+      end
+
+      activity
+    end
 
-      begin
-        response = access_token.post 'api/v2/activities', :body => {:activity => params}
-        return MultiJson.decode(response.body)
+    def self.access_token
+      @access_token ||= begin
+        oauth_access_token = ProoflinkConnect.config.oauth_access_token
+        client = OAuth2::Client.new(nil, nil, {:site => ProoflinkConnect.config.base_uri})
+        access_token = OAuth2::AccessToken.new(client, oauth_access_token, :header_format => "OAuth %s")
+      end
+    end
 
-      rescue OAuth2::Error => error
-        return MultiJson.decode(error.response.body)
+    def self.perform_request?
+      if !ProoflinkConnect.config.enable_activity_tracking.nil?
+        return ProoflinkConnect.config.enable_activity_tracking
       end
+      return false if defined?(Rails) && !Rails.env.production?
+      return false if ENV['RACK_ENV'] && ENV['RACK_ENV'] != "production"
+      true
     end
   end
 end
+

data/lib/prooflink_connect/configuration.rb

@@ -14,7 +14,7 @@ module ProoflinkConnect
       @@defaults.each_pair{|k,v| self.send("#{k}=",v)}
     end
 
-    attr_accessor :provider_endpoint, :subdomain, :api_key, :protocol, :locale, :oauth_access_token
+    attr_accessor :provider_endpoint, :subdomain, :api_key, :protocol, :locale, :oauth_access_token, :enable_activity_tracking
 
     def validate!
       raise InvalidConfigurationError if [:provider_endpoint, :subdomain, :api_key, :protocol].any?{|option|send(option).blank?}

data/lib/prooflink_connect/version.rb

@@ -1,3 +1,3 @@
 module ProoflinkConnect
-  VERSION = "0.0.23"
+  VERSION = "0.0.24"
 end

data/spec/prooflink_connect/activity_spec.rb

@@ -5,25 +5,44 @@ describe ProoflinkConnect::Activity do
     reset_configuration
   end
 
-  before do
+  it "should log activity as expected" do
     stub_request(:post, "https://example.prooflink.com/api/v2/activities").
       with(:body => {"activity"=>{"activity_type"=>{"name"=>"My name", "value"=>"1", "identifier"=>"my_identifier"}, "user"=>{"identity_provider"=>"prooflink", "email"=>"jon@doe.com"}}}, :headers => {'Accept'=>'*/*', 'Authorization'=>'OAuth 4321', 'Content-Type'=>'application/x-www-form-urlencoded'}).
       to_return(:status => 200, :body => MultiJson.encode({"status"=>"SUCCESS", "message"=>"activity succesfully created"}), :headers => {})
+    params = {:activity_type => {:identifier => "my_identifier", :name => "My name", :value => 1},
+              :user => {:email => "jon@doe.com", :identity_provider => 'prooflink'}}
 
+    ProoflinkConnect::Activity.log(params).should eq({"status"=>"SUCCESS", "message"=>"activity succesfully created"})
+  end
+
+  it "rescues OAuth2::Error exceptions" do
     stub_request(:post, "https://example.prooflink.com/api/v2/activities").
       with(:body => "", :headers => {'Accept'=>'*/*', 'Authorization'=>'OAuth 4321', 'Content-Type'=>'application/x-www-form-urlencoded'}).
       to_return(:status => 406, :body => MultiJson.encode({"status"=>"ERROR", "message"=>"no activity specified"}), :headers => {})
+    ProoflinkConnect::Activity.log({}).should eq({"status"=>"ERROR", "message"=>"no activity specified"})
   end
 
-  it "should log activity as expected" do
-    params = {:activity_type => {:identifier => "my_identifier", :name => "My name", :value => 1},
-              :user => {:email => "jon@doe.com", :identity_provider => 'prooflink'}}
-
-    ProoflinkConnect::Activity.log(params).should eq({"status"=>"SUCCESS", "message"=>"activity succesfully created"})
+  it "new user" do
+    stub_request(:post, "https://example.prooflink.com/api/v2/activities").
+      with(:body => {"activity" => {"activity_type" => {"identifier" => "follow", "name" => "Following", "value" => "1"}, "user" => {"identity_provider" => "prooflink", "email" => "jon@doe.com"}}}).
+      to_return(:status => 200, :body => MultiJson.encode({"status" => "SUCCESS", "message" => "activity succesfully created"}), :headers => {})
+    user = {:email => "jon@doe.com", :identity_provider => 'prooflink'}
+    options = {:activity_name => "Following", :activity_value => 1}
+    ProoflinkConnect::Activity.track("follow", user, options)
+  end
 
+  it "existing user" do
+    stub_request(:post, "https://example.prooflink.com/api/v2/activities").
+      with(:body => {"activity" => {"activity_type" => {"identifier" => "follow", "name" => "Following", "value" => "1"}, "user" => {"identifier" => "12345", "identity_provider" => "prooflink"}}}).
+      to_return(:status => 200, :body => MultiJson.encode({"status" => "SUCCESS", "message" => "activity succesfully created"}), :headers => {})
+    options = {:activity_name => "Following", :activity_value => 1}
+    ProoflinkConnect::Activity.track("follow", "12345", options)
   end
 
-  it "should not log activity when no params are passed" do
-    ProoflinkConnect::Activity.log({}).should eq({"status"=>"ERROR", "message"=>"no activity specified"})
+  it "allows disabling of activity tracking" do
+    ProoflinkConnect.config.enable_activity_tracking = false
+    ProoflinkConnect::Activity.should_not_receive(:build_request)
+    ProoflinkConnect::Activity.track("follow", "12345")
   end
 end
+

data/spec/prooflink_connect_spec.rb

@@ -96,4 +96,9 @@ describe ProoflinkConnect do
       ProoflinkConnect.embedded(:scenario => "split_screen").should == result
     end
   end
+
+  it "tracks activities" do
+    ProoflinkConnect::Activity.should_receive(:track).with("follow", "12345", {})
+    ProoflinkConnect.track_activity("follow", "12345")
+  end
 end

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: prooflink_connect
 version: !ruby/object:Gem::Version 
-  hash: 49
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 23
-  version: 0.0.23
+  version: 0.0.24
 platform: ruby
 authors: 
 - Chiel Wester
@@ -18,108 +12,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-25 00:00:00 Z
+date: 2013-04-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multi_json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - &id002 
+      - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: httparty
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id002
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id002
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id002
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id002
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: oauth2
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    - *id002
   type: :runtime
-  version_requirements: *id007
+  version_requirements: *id008
 description: Make a connection to the prooflink connect api for single sign on authentication
 email: 
 - chiel.wester@holder.nl
@@ -160,37 +115,27 @@ files:
 homepage: https://github.com/prooflink/prooflink_connect
 licenses: []
 
+metadata: {}
+
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id002
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: prooflink_connect
-rubygems_version: 1.8.12
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Make a connection to the prooflink connect api
 test_files: []