shareprogress 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7ff16026620a0a3a79d334f2686ca529b5d63d9
+  data.tar.gz: 49943db011437445cb7043cbff330379502b1ec3
+SHA512:
+  metadata.gz: e942769c2221619479cd1e6fa38d0623268b2a330a96bea62f7e6dc512caf243acc62259dceebc5b0e9f7777174d901bbddb5db37cc3b2fa18309d280e57122b
+  data.tar.gz: f08502dce4e30f60338a2598226dd263361b7c179861625326842ab5049ea400fb997895671d6a52d69e067807728663cd48273d7453a525fe1b202299236f59

data/.gems

@@ -0,0 +1,3 @@
+cutest -v 1.2.2
+requests -v 1.0.0
+scrivener -v 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.gs

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+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,10 @@
+# shareprogress
+
+The shareprogress library is designed to be a Ruby interface to the [ShareProgress](http://www.shareprogress.org/)
+API. It provides a simple Plain Old Ruby Object interface to the API.
+
+##Installation
+
+```
+$ gem install shareprogress
+```

data/Rakefile

@@ -0,0 +1,3 @@
+task :test do
+  puts `cutest ./test/*.rb`
+end

data/lib/shareprogress/filters/new_button.rb

@@ -0,0 +1,47 @@
+class NewButton < Scrivener
+  attr_accessor :key, :page_url, :button_template, :page_title
+  attr_accessor :auto_fill, :advanced_options, :variants
+
+  def validate
+    assert_present :key
+    assert_url :page_url
+
+    assert_member :button_template, %w{sp_em_small sp_em_large sp_tw_small
+      sp_tw_large sp_fb_small sp_fb_large}
+
+    assert_present :variants
+
+    if auto_fill
+      assert auto_fill == false || auto_fill == true, [:auto_fill, :not_boolean]
+    end
+
+    if advanced_options
+      if advanced_options["automatic_traffic_routing"]
+        assert advanced_options["automatic_traffic_routing"] == false ||
+          advanced_options["automatic_traffic_routing"] == true, [:automatic_traffic_routing, :not_boolean]
+      end
+
+      if advanced_options["buttons_optimize_actions"]
+        assert advanced_options["buttons_optimize_actions"] == false ||
+          advanced_options["buttons_optimize_actions"] == true, [:buttons_optimize_actions, :not_boolean]
+      end
+
+      if advanced_options["customize_params"]
+        cp = advanced_options["customize_params"]
+
+        assert !cp["param"].nil?, [:param, :not_present]
+        assert !cp["e"].nil?, [:e, :not_present]
+        assert !cp["f"].nil?, [:f, :not_present]
+        assert !cp["t"].nil?, [:t, :not_present]
+        assert !cp["o"].nil?, [:o, :not_present]
+      end
+
+      if advanced_options["id_pass"]
+        ip = advanced_options["id_pass"]
+
+        assert !ip["id"].nil?, [:id, :not_present]
+        assert !ip["passed"].nil?, [:passed, :not_present]
+      end
+    end
+  end
+end

data/lib/shareprogress/filters/new_email_variants.rb

@@ -0,0 +1,26 @@
+class NewEmailVariants < Scrivener
+  attr_accessor :email, :button_template
+
+  def validate
+    assert_member :button_template, %w{sp_em_small sp_em_large}
+
+    if assert_present :email
+      email.each do |e|
+
+        if assert !e["email_subject"].nil?, [:email_subject, :nil]
+          assert !e["email_subject"].empty?, [:email_subject, :empty]
+        end
+
+        if assert !e["email_body"].nil?, [:email_body, :nil]
+
+          if assert !e["email_body"].empty?, [:email_body, :empty]
+            assert e["email_body"].include?("{LINK}"), [:email_body, :link_not_included]
+          end
+
+        end
+
+      end
+    end
+
+  end
+end

data/lib/shareprogress/filters/new_facebook_variants.rb

@@ -0,0 +1,25 @@
+class NewFacebookVariants < Scrivener
+  attr_accessor :facebook, :button_template
+
+  def validate
+    assert_member :button_template, %w{sp_fb_small sp_fb_large}
+
+    if assert_present :facebook
+      facebook.each do |f|
+
+        if assert !f["facebook_title"].nil?, [:facebook_title, :nil]
+          assert !f["facebook_title"].empty?, [:facebook_title, :empty]
+        end
+
+        if assert !f["facebook_description"].nil?, [:facebook_description, :nil]
+          assert !f["facebook_description"].empty?, [:facebook_description, :empty]
+        end
+
+        if assert !f["facebook_thumbnail"].nil?, [:facebook_thumbnail, :nil]
+          assert !f["facebook_thumbnail"].empty?, [:facebook_thumbnail, :empty]
+        end
+
+      end
+    end
+  end
+end

data/lib/shareprogress/filters/new_twitter_variants.rb

@@ -0,0 +1,21 @@
+class NewTwitterVariants < Scrivener
+  attr_accessor :twitter, :button_template
+
+  def validate
+    assert_member :button_template, %w{sp_tw_small sp_tw_large}
+
+    if assert_present :twitter
+      twitter.each do |t|
+
+        if assert !t["twitter_message"].nil?, [:twitter_message, :nil]
+
+          if assert !t["twitter_message"].empty?, [:twitter_message, :empty]
+            assert t["twitter_message"].include?("{LINK}"), [:twitter_message, :link_not_included]
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/shareprogress.rb

@@ -0,0 +1,143 @@
+require "scrivener"
+require "requests"
+
+require_relative "shareprogress/filters/new_button"
+require_relative "shareprogress/filters/new_email_variants"
+require_relative "shareprogress/filters/new_twitter_variants"
+require_relative "shareprogress/filters/new_facebook_variants"
+
+module ShareProgress
+  module Button
+    def self.request(method, payload)
+      case method
+      when "create"
+        url = "https://run.shareprogress.org/api/v1/buttons/update"
+      when "update"
+        # ...
+      end
+
+      response = Requests.request("POST", url,
+        data: JSON.dump(payload),
+        headers: { "Content-Type" => "application/json" }
+      )
+
+      return JSON.parse(response.body)
+    end
+
+    def self.create(data)
+      # Validates the input (a hash) to send a POST request to
+      # ShareProgress to create a share button. The result could be:
+      # a) A hash containing the information of the created button or,
+      # b) An Error message from ShareProgress (i.e. 'Bad API key').
+
+      # Arguments received:
+      # data: A hash containing all the info about the button. For example:
+      # {
+      #   "key" => "123456",
+      #   "page_url" => "http://sumofus.org/",
+      #   "page_title" => "My button name",
+      #   "auto_fill" => true,
+      #   "button_template" => "sp_em_large",
+      #   "variants" => {
+      #     "email" => [
+      #       {"email_subject" => "Email subject 1!",
+      #         "email_body" => "Email body 1 {LINK}"},
+      #       {"email_subject" => "Email subject 2!",
+      #         "email_body" => "Email body 2 {LINK}"},
+      #       {"email_subject" => "Email subject 3!",
+      #         "email_body" => "Email body 3 {LINK}"}
+      #       ]
+      #     },
+      #   "advanced_options" => {
+      #     "automatic_traffic_routing" => true,
+      #     "buttons_optimize_actions" => true,
+      #     "customize_params" => {
+      #       "param" => "param_to_use",
+      #       "e" => "email_source",
+      #       "f" => "facebook_source",
+      #       "t" => "twitter_source",
+      #       "o" => "dark_social_source"
+      #     },
+      #     "id_pass" => {
+      #     "id" => "id",
+      #     "passed" => "referrer_id"
+      #     }
+      #   }
+      # }
+
+      # Example of a successful response:
+      # {
+      #   "id"=>12136,
+      #   "page_url"=>"http://sumofus.org/",
+      #   "page_title"=>"My button name",
+      #   "button_template"=>"sp_em_large",
+      #   "share_button_html"=>"<div class='sp_12136 sp_em_large' ></div>",
+      #   "found_snippet"=>false,
+      #   "is_active"=>false,
+      #   "variants"=>{
+      #     "facebook"=>[{
+      #       "id"=>48542,
+      #         "facebook_title"=>"SumOfUs",
+      #         "facebook_description"=>"SumOfUs is a global movement of "\
+      #         "consumers, investors, and workers all around the world, "\
+      #         "standing together to hold corporations accountable for their "\
+      #         "actions and forge a new, sustainable and just path for our "\
+      #         "global economy. It's not going to be fast or easy. B",
+      #         "facebook_thumbnail"=>"http://sumofus.org/wp-content/themes/pgm/"\
+      #         "img/default-facebook.jpg"}],
+      #     "email"=>[{
+      #       "id"=>48539,
+      #         "email_subject"=>"Email subject 1!",
+      #         "email_body"=>"Email body 1 {LINK}"}, {
+      #       "id"=>48540,
+      #         "email_subject"=>"Email subject 2!",
+      #         "email_body"=>"Email body 2 {LINK}"}, {
+      #       "id"=>48541,
+      #         "email_subject"=>"Email subject 3!",
+      #         "email_body"=>"Email body 3 {LINK}"}],
+      #     "twitter"=>[{
+      #       "id"=>48543,
+      #       "twitter_message"=>"SumOfUs {LINK}"}]},
+      #   "advanced_options"=>{
+      #     "automatic_traffic_routing"=>true,
+      #     "buttons_optimize_actions"=>true,
+      #     "customize_params"=>{
+      #       "param"=>"param_to_use",
+      #       "e"=>"email_source",
+      #       "f"=>"facebook_source",
+      #       "t"=>"twitter_source",
+      #       "o"=>"dark_social_source"},
+      #     "id_pass"=>{
+      #       "id"=>"id",
+      #       "passed"=>"referrer_id"}}
+      # }
+      button = NewButton.new(data)
+
+      unless button.valid?
+        return button.errors
+      end
+
+      button_variants = button.variants.merge(button_template: button.button_template)
+
+      if button.variants["email"]
+        variants = NewEmailVariants.new(button_variants)
+      elsif button.variants["twitter"]
+        variants = NewTwitterVariants.new(button_variants)
+      elsif button.variants["facebook"]
+        variants = NewFacebookVariants.new(button_variants)
+      end
+
+      unless variants.valid?
+        return variants.errors
+      end
+
+      # send request to ShareProgress to create a button
+      begin
+        request = request("create", button.attributes)
+        return request["response"][0]
+      rescue Requests::Error => e
+        return JSON.parse(e.response.body)["message"]
+      end
+    end
+  end
+end

data/shareprogress.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "shareprogress"
+  s.version = "0.0.1"
+  s.summary = "Ruby gem to communicate with ShareProgress API"
+  s.description = s.summary
+  s.authors = ["Cecilia Rivero"]
+  s.email = ["contact@ceciliarivero.com"]
+  s.homepage = "https://github.com/ceciliarivero/shareprogress-rb"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_runtime_dependency "requests", "~> 0"
+  s.add_runtime_dependency "scrivener", "~> 0"
+
+  s.add_development_dependency "cutest", "~> 0"
+end

data/test/create_button_test.rb

@@ -0,0 +1,314 @@
+require "cutest"
+require_relative "../lib/shareprogress"
+
+# Monkeypath the communication with ShareProgress
+module ShareProgress
+  module Button
+    def self.request(method, payload)
+      return {
+        "success"=>true,
+        "response"=>[{
+          "id"=>12136,
+          "page_url"=>"http://sumofus.org/",
+          "page_title"=>"My button name",
+          "button_template"=>"sp_em_large",
+          "share_button_html"=>"<div class='sp_12136 sp_em_large' ></div>",
+          "found_snippet"=>false,
+          "is_active"=>false,
+          "variants"=>{
+            "facebook"=>[{
+              "id"=>48542,
+              "facebook_title"=>"SumOfUs",
+              "facebook_description"=>"SumOfUs is a global movement of "\
+                "consumers, investors, and workers all around the world, standing "\
+                "together to hold corporations accountable for their actions and "\
+                "forge a new, sustainable and just path for our global economy. "\
+                "It's not going to be fast or easy. B",
+              "facebook_thumbnail"=>"http://sumofus.org/wp-content/themes/"\
+                "pgm/img/default-facebook.jpg"}],
+            "email"=>[{
+              "id"=>48539,
+                "email_subject"=>"Email subject 1!",
+                "email_body"=>"Email body 1 {LINK}"}, {
+              "id"=>48540,
+                "email_subject"=>"Email subject 2!",
+                "email_body"=>"Email body 2 {LINK}"}, {
+              "id"=>48541,
+                "email_subject"=>"Email subject 3!",
+                "email_body"=>"Email body 3 {LINK}"}],
+            "twitter"=>[{
+              "id"=>48543,
+              "twitter_message"=>"SumOfUs {LINK}"}]},
+          "advanced_options"=>{
+            "automatic_traffic_routing"=>true,
+            "buttons_optimize_actions"=>true,
+            "customize_params"=>{
+              "param"=>"param_to_use",
+              "e"=>"email_source",
+              "f"=>"facebook_source",
+              "t"=>"twitter_source",
+              "o"=>"dark_social_source"},
+            "id_pass"=>{
+              "id"=>"id",
+              "passed"=>"referrer_id"}}}],
+        "message"=>nil
+      }
+    end
+  end
+end
+
+setup do
+  {
+    "key" => "123456",
+    "page_url" => "http://sumofus.org/",
+    "page_title" => "My button name",
+    "auto_fill" => true,
+    "button_template" => "sp_em_large",
+    "variants" => {
+      "email" => [
+        {"email_subject" => "Email subject 1!",
+          "email_body" => "Email body 1 {LINK}"},
+        {"email_subject" => "Email subject 2!",
+          "email_body" => "Email body 2 {LINK}"},
+        {"email_subject" => "Email subject 3!",
+          "email_body" => "Email body 3 {LINK}"}
+      ]
+    },
+    "advanced_options" => {
+      "automatic_traffic_routing" => true,
+      "buttons_optimize_actions" => true,
+      "customize_params" => {
+        "param" => "param_to_use",
+        "e" => "email_source",
+        "f" => "facebook_source",
+        "t" => "twitter_source",
+        "o" => "dark_social_source"
+      },
+      "id_pass" => {
+        "id" => "id",
+        "passed" => "referrer_id"
+      }
+    }
+  }
+end
+
+scope do
+  # all
+  test "create button successfully" do |data|
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {
+      "id"=>12136,
+      "page_url"=>"http://sumofus.org/",
+      "page_title"=>"My button name",
+      "button_template"=>"sp_em_large",
+      "share_button_html"=>"<div class='sp_12136 sp_em_large' ></div>",
+      "found_snippet"=>false,
+      "is_active"=>false,
+      "variants"=>{
+        "facebook"=>[{
+          "id"=>48542,
+            "facebook_title"=>"SumOfUs",
+            "facebook_description"=>"SumOfUs is a global movement of "\
+            "consumers, investors, and workers all around the world, "\
+            "standing together to hold corporations accountable for their "\
+            "actions and forge a new, sustainable and just path for our "\
+            "global economy. It's not going to be fast or easy. B",
+            "facebook_thumbnail"=>"http://sumofus.org/wp-content/themes/pgm/"\
+            "img/default-facebook.jpg"}],
+        "email"=>[{
+          "id"=>48539,
+            "email_subject"=>"Email subject 1!",
+            "email_body"=>"Email body 1 {LINK}"}, {
+          "id"=>48540,
+            "email_subject"=>"Email subject 2!",
+            "email_body"=>"Email body 2 {LINK}"}, {
+          "id"=>48541,
+            "email_subject"=>"Email subject 3!",
+            "email_body"=>"Email body 3 {LINK}"}],
+        "twitter"=>[{
+          "id"=>48543,
+          "twitter_message"=>"SumOfUs {LINK}"}]},
+      "advanced_options"=>{
+        "automatic_traffic_routing"=>true,
+        "buttons_optimize_actions"=>true,
+        "customize_params"=>{
+          "param"=>"param_to_use",
+          "e"=>"email_source",
+          "f"=>"facebook_source",
+          "t"=>"twitter_source",
+          "o"=>"dark_social_source"},
+        "id_pass"=>{
+          "id"=>"id",
+          "passed"=>"referrer_id"}}
+      }
+
+    assert result == expected_result
+  end
+
+  # key
+  test "create button with no key" do |data|
+    data["key"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:key=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  # page_url
+  test "create button with no page_url" do |data|
+    data["page_url"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:page_url=>[:not_url]}
+
+    assert result == expected_result
+  end
+
+  # button_template
+  test "create button with nil button_template" do |data|
+    data["button_template"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:button_template=>[:not_valid]}
+
+    assert result == expected_result
+  end
+
+  test "create button with empty button_template" do |data|
+    data["button_template"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:button_template=>[:not_valid]}
+
+    assert result == expected_result
+  end
+
+  test "create button with wrong button_template" do |data|
+    data["button_template"] = "wrong_button_template"
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:button_template=>[:not_valid]}
+
+    assert result == expected_result
+  end
+
+  # auto_fill
+  test "create button with not boolean auto_fill" do |data|
+    data["auto_fill"] = ""
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:auto_fill=>[:not_boolean]}
+
+    assert result == expected_result
+  end
+
+  # variants
+  test "create button with no variants" do |data|
+    data["variants"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:variants=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  # advanced_options
+  test "create button with not boolean automatic_traffic_routing" do |data|
+    data["advanced_options"]["automatic_traffic_routing"] = ""
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:automatic_traffic_routing=>[:not_boolean]}
+
+    assert result == expected_result
+  end
+
+  test "create button with not boolean buttons_optimize_actions" do |data|
+    data["advanced_options"]["buttons_optimize_actions"] = ""
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:buttons_optimize_actions=>[:not_boolean]}
+
+    assert result == expected_result
+  end
+
+  test "create button with no param in customize_params" do |data|
+    data["advanced_options"]["customize_params"]["param"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:param=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  test "create button with no e in customize_params" do |data|
+    data["advanced_options"]["customize_params"]["e"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:e=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  test "create button with no f in customize_params" do |data|
+    data["advanced_options"]["customize_params"]["f"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:f=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  test "create button with no t in customize_params" do |data|
+    data["advanced_options"]["customize_params"]["t"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:t=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  test "create button with no o in customize_params" do |data|
+    data["advanced_options"]["customize_params"]["o"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:o=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  test "create button with no id in id_pass" do |data|
+    data["advanced_options"]["id_pass"]["id"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:id=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  test "create button with no passed in id_pass" do |data|
+    data["advanced_options"]["id_pass"]["passed"] = nil
+
+    result = ShareProgress::Button.create(data)
+
+    expected_result = {:passed=>[:not_present]}
+
+    assert result == expected_result
+  end
+end