settlebox 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Johan Gyllenspetz
+
+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,94 @@
+# Settlebox
+
+Rails view helpers for easy integration with the SettleBox API.
+
+## Installation
+
+Add this line to your Gemfile:
+
+    gem 'settlebox'
+
+The run:
+
+    $ bundle install
+
+## Configuration
+
+When you signup for SettleBox you will recieve an API_KEY and an API_SECRET. Put these in an initializer for your application.
+
+    #config/initializers/settlebox.rb
+    require 'settlebox'
+    Settlebox.config do |config|
+        config.api_key = "API_KEY"
+        config.api_secret = "API_SECRET"
+        config.lang = :en # This optional currently :en and :sv are supported, :en is default
+    end
+
+After this you are ready to go.
+
+## Usage
+
+The gem comes with a couple of helpers that helps you include the SettleBox widget.
+For a more fancy description of the API with interactive guides see [SettleBox homepage](https://settlebox.com/partner/api).
+
+### Javascript
+
+Include the javascript tag on any page that you want to make use of the SettleBox profile.
+
+    = settlebox_include_tag
+
+### View helpers
+
+
+#### Signup
+
+Include this on the users settings profile page.
+
+    = settlebox_card_tag('demo_full@settlebox.com')
+    
+#### Reputation
+    
+Include this where you have more space and want to show the complete SettleBox profile of the user.
+
+    = settlebox_reputation_tag('demo_full@settlebox.com')
+    
+#### Listing (Cube)
+    
+This is the SettleBox cube which has an hoovering effect. Use this where you have alot of items in a list.
+
+    # href tells SettleBox where to go if the cube is clicked
+    = settlebox_listing_tag('demo_full@settlebox.com', href="https://settlebox.com)
+
+## Debugging
+
+To easily try out the SettleBox gem and API. There exists a demo user. The demo user has the following email address
+
+    # Replace the * depending on how much information you want the profile to show 
+    demo_*@settlebox.com
+    
+    # Examples
+    
+    # Will show a profile of a user that has connected everything there is to connect.
+    demo_full@settlebox.com
+    
+    # Will show a user that only has connected facebook
+    demo_fb@settlebox.com
+    
+    # Will show a user with an avatar, ebay and twitter
+    demo_av_eb_tw@settlebox.com
+    
+Supported options for the demo user are.
+
+* av = Avatar
+* fb = Facebook
+* tw = Twitter
+* li = LinkedIn
+* eb = Ebay
+* tr = Tradera
+* pe = Percent of good ratings
+* to = Total number of ratings
+* aa = Total number of listings the user have
+
+## More on SettleBox
+
+For more information about SettleBox please refer to our homepage [SettleBox homepage](https://settlebox.com/partner).

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/settlebox'
+  t.test_files = FileList['test/lib/settlebox/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/settlebox.rb

@@ -0,0 +1,29 @@
+require "settlebox/version"
+require "settlebox/crypt"
+require "settlebox/view_helpers"
+require 'settlebox/railtie' if defined?(Rails::Railtie)
+
+module Settlebox
+  class SettleboxError < StandardError;end
+  class SettleboxConfigError < SettleboxError;end
+
+  class Configuration
+    attr_accessor :api_key, :api_secret, :language, :url
+
+    def initialize
+      self.language = 'en'
+    end
+  end
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  def self.config
+    yield(configuration) if block_given?
+
+    raise SettleboxConfigError.new("api_key can't be blank") if @configuration.api_key == nil
+    raise SettleboxConfigError.new("api_secret needs to be 64 charachters long") if @configuration.api_secret.length != 64
+    raise SettleboxConfigError.new("language not supported") unless [:en, :sv].include?(@configuration.language)
+  end
+end

data/lib/settlebox/crypt.rb

@@ -0,0 +1,23 @@
+require 'base64'
+require 'digest/md5'
+require 'openssl'
+
+module Settlebox
+  module Crypt
+    # http://jdwyah.blogspot.se/2009/12/decrypting-ruby-aes-encryption.html
+    def self.encrypt(string, key)
+      Base64.encode64(aes(key, string)).gsub /\s/, ''
+    end
+
+    def self.aes(key, string)
+      key = Array(key).pack 'H*'
+      cipher = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+      cipher.encrypt
+      cipher.key = key
+      cipher.iv = initialization_vector = cipher.random_iv
+      cipher_text = cipher.update(string)
+      cipher_text << cipher.final
+      return initialization_vector + cipher_text
+    end
+  end
+end

data/lib/settlebox/railtie.rb

@@ -0,0 +1,7 @@
+module Settlebox
+  class Railtie < Rails::Railtie
+    initializer "settlebox.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/settlebox/version.rb

@@ -0,0 +1,4 @@
+module Settlebox
+  VERSION = "0.0.1"
+  API_VERSION = 1
+end

data/lib/settlebox/view_helpers.rb

@@ -0,0 +1,68 @@
+unless defined?(Rails)
+  class String
+    def html_safe
+      self
+    end
+  end
+end
+
+module Settlebox
+  module ViewHelpers
+    def settlebox_include_tag(async=true)
+      ret = ""
+
+      api_key = Settlebox.configuration.api_key
+      language = Settlebox.configuration.language
+      api_version = Settlebox::API_VERSION
+
+      url = Settlebox.configuration.url ? Settlebox.configuration.url : "https://settlebox.com"
+      src = "#{url}/assets/widgets/reputation.js";
+
+      ret += "\n<script>\n";
+      ret += "(function(w,d,t,u,o,k,l,v,e,p){";
+      ret += "w[o]=w[o]||{};";
+      ret += "w[o].key=k;";
+      ret += "w[o].lang=l;";
+      ret += "w[o].ver=v;";
+      ret += "e=d.createElement(t);";
+      ret += "p=d.getElementsByTagName(t)[0];";
+      if async
+        ret += "e.async=1;";
+      else
+        ret += "w[o].sync=!0;";
+      end
+      ret += "e.src=u;";
+      ret += "p.parentNode.insertBefore(e,p);";
+      ret += "}(window,document,'script','#{src}','SB','#{api_key}', '#{language}', '#{api_version}'));";
+      ret += "\n</script>\n";
+
+      ret.html_safe
+    end
+
+    def settlebox_reputation_tag(email)
+      demail = crypt_email(email)
+      "<div id='settlebox-reputation' data-sb-email='#{demail}'></div>".html_safe
+    end
+
+    def settlebox_listing_tag(email, href = false)
+      demail = crypt_email(email)
+      href = href ? href : "https://settlebox.com"
+      "<div class='settlebox-listing' data-sb-email='#{demail}' data-sb-href='#{href}'></div>".html_safe
+    end
+
+    def settlebox_card_tag(email)
+      demail = crypt_email(email)
+
+      unless email =~ /^demo_.*@settlebox.com$/
+        "<div class='settlebox-card' data-sb-email='#{demail}' data-sb-email-plain=#{email}></div>".html_safe
+      else
+        "<div class='settlebox-card' data-sb-demo='true'></div>".html_safe
+      end
+    end
+
+    private
+    def crypt_email(email)
+      Settlebox::Crypt.encrypt(email, Settlebox.configuration.api_secret)
+    end
+  end
+end

data/settlebox.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'settlebox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "settlebox"
+  spec.version       = Settlebox::VERSION
+  spec.authors       = ["Johan Gyllenspetz"]
+  spec.email         = ["johan.gyllenspetz@gmail.com"]
+  spec.description   = %q{SettleBox}
+  spec.summary       = %q{Easy integration with the SettleBox API}
+  spec.homepage      = "https://github.com/popgiro/settlebox-rails"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/lib/settlebox/config_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../test_helper'
+
+describe Settlebox do
+  let(:api_key) {"api_key"}
+  let(:api_secret) {"0123456789012345678901234567890123456789012345678901234567891234"}
+  let(:language) {:en}
+
+   it "shoulde be able to configure" do
+    Settlebox.config do |config|
+      config.api_key = api_key
+      config.api_secret = api_secret
+      config.language = language
+    end
+
+    assert_equal Settlebox.configuration.api_key, api_key
+    assert_equal Settlebox.configuration.api_secret, api_secret
+    assert_equal Settlebox.configuration.language, language
+  end
+
+  it "should raise error if no api key" do
+    assert_raises Settlebox::SettleboxConfigError do
+      Settlebox.config do |config|
+        config.api_secret = api_secret
+        config.api_key = nil
+        config.language = language
+      end
+    end
+  end
+
+  it "should raise error if api_secret is to short" do
+    assert_raises Settlebox::SettleboxConfigError do
+      Settlebox.config do |config|
+        config.api_secret = "7005h0r7"
+        config.api_key = api_key
+        config.language = language
+      end
+    end
+  end
+
+  it "should raise error if language not supported" do
+    assert_raises Settlebox::SettleboxConfigError do
+      Settlebox.config do |config|
+        config.api_secret = api_secret
+        config.api_key = api_key
+        config.language = :xx
+      end
+    end
+  end
+end

data/test/lib/settlebox/crypt_test.rb

@@ -0,0 +1,10 @@
+require_relative '../../test_helper'
+
+describe Settlebox do
+  let(:key) {"B374A26A71490437AA024E4FADD5B497FDFF1A8EA6FF12F6FB65AF2720B59CCF"}
+  let(:string) {"settlebox@example.com"}
+
+  it "be able to crypt" do
+    Settlebox::Crypt.encrypt(string, key).wont_be_nil
+  end
+end

data/test/lib/settlebox/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe Settlebox do
+  it "must be defined" do
+    Settlebox::VERSION.wont_be_nil
+  end
+end

data/test/lib/settlebox/view_helper_test.rb

@@ -0,0 +1,37 @@
+require_relative '../../test_helper'
+
+class SBHelper
+  include Settlebox::ViewHelpers
+end
+
+describe Settlebox do
+  let(:email) {"settlebox@example.com"}
+  let(:sb) {SBHelper.new}
+
+  before(:each) do
+    Settlebox.config do |config|
+      config.api_key = "7569373564584bc684648202838737"
+      config.api_secret = "B374A26A71490437AA024E4FADD5B497FDFF1A8EA6FF12F6FB65AF2720B59CCF"
+      config.language = :en
+    end
+  end
+
+  it "should generate card tag" do
+    sb.settlebox_card_tag(email)
+  end
+
+  it "should generate reputation tag" do
+    sb.settlebox_reputation_tag(email)
+  end
+
+  it "should generate listing tag" do
+    sb.settlebox_listing_tag(email)
+    sb.settlebox_listing_tag(email, "/test")
+  end
+
+  it "should generate include tag" do
+    sb.settlebox_include_tag
+    sb.settlebox_include_tag(false)
+    sb.settlebox_include_tag(true)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/settlebox.rb', __FILE__)

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: settlebox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Johan Gyllenspetz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SettleBox
+email:
+- johan.gyllenspetz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/settlebox.rb
+- lib/settlebox/crypt.rb
+- lib/settlebox/railtie.rb
+- lib/settlebox/version.rb
+- lib/settlebox/view_helpers.rb
+- settlebox.gemspec
+- test/lib/settlebox/config_test.rb
+- test/lib/settlebox/crypt_test.rb
+- test/lib/settlebox/version_test.rb
+- test/lib/settlebox/view_helper_test.rb
+- test/test_helper.rb
+homepage: https://github.com/popgiro/settlebox-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy integration with the SettleBox API
+test_files:
+- test/lib/settlebox/config_test.rb
+- test/lib/settlebox/crypt_test.rb
+- test/lib/settlebox/version_test.rb
+- test/lib/settlebox/view_helper_test.rb
+- test/test_helper.rb