shareprogress 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 271e9682aa7a81d6fb0f52678aaab0cbef3cc5a1
-  data.tar.gz: f3823bff697e54d4a06eb3b619823ae9a6dbe211
+  metadata.gz: 082477b4615f11fc7b720305663a0d83875fecee
+  data.tar.gz: 49f04eb0b8878236853d97afaf511431a6adb4ed
 SHA512:
-  metadata.gz: b6497fb1519499b7fda95195d70017a626f24a009c712e33f4b5f89a4bcaf2207a15b5597b441e0f48544703986dd6035aae598db0dc27100d71f857ebb678b4
-  data.tar.gz: 158264c71e812c69ce7f189de57eada2ce5be4406f16dc4fe8284136b1cb6f41d891b7c38bd59a99d91b235ce36cec8bb6633016843c9aa0d8703b6a9cb14f5c
+  metadata.gz: 92e3469f882b16bd44869b00c55523a189e9d4c4f7ac9952e02ff5f9f7a0716a8dda751174ca0f29daaaafba702b67d7f6d7c36f82b2fd321e1649d843d78ba6
+  data.tar.gz: 284c0b6a7dabdb83fe3506efff60d5da1b72f2c3724b83465ccf1c90b29a21c0e699fc7724947094a430473b97550d719f93ce3dee0b6d26d25242c781c51fe7

data/.gitignore

@@ -1,3 +1,2 @@
 .DS_Store
 .gs
-shareprogress-0.0.1.gem

data/lib/shareprogress.rb

@@ -1,10 +1,11 @@
 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"
+require_relative "shareprogress/filters/create_button"
+require_relative "shareprogress/filters/create_email_variants"
+require_relative "shareprogress/filters/create_twitter_variants"
+require_relative "shareprogress/filters/create_facebook_variants"
+require_relative "shareprogress/filters/read_button"
 
 module ShareProgress
   module Button
@@ -12,8 +13,8 @@ module ShareProgress
       case method
       when "create"
         url = "https://run.shareprogress.org/api/v1/buttons/update"
-      when "update"
-        # ...
+      when "read"
+        url = "https://run.shareprogress.org/api/v1/buttons/read"
       end
 
       response = Requests.request("POST", url,
@@ -111,7 +112,7 @@ module ShareProgress
       #       "id"=>"id",
       #       "passed"=>"referrer_id"}}
       # }
-      button = NewButton.new(data)
+      button = CreateButton.new(data)
 
       unless button.valid?
         return button.errors
@@ -120,11 +121,11 @@ module ShareProgress
       button_variants = button.variants.merge(button_template: button.button_template)
 
       if button.variants["email"]
-        variants = NewEmailVariants.new(button_variants)
+        variants = CreateEmailVariants.new(button_variants)
       elsif button.variants["twitter"]
-        variants = NewTwitterVariants.new(button_variants)
+        variants = CreateTwitterVariants.new(button_variants)
       elsif button.variants["facebook"]
-        variants = NewFacebookVariants.new(button_variants)
+        variants = CreateFacebookVariants.new(button_variants)
       end
 
       unless variants.valid?
@@ -139,5 +140,21 @@ module ShareProgress
         return JSON.parse(e.response.body)["message"]
       end
     end
+
+    def self.read(data)
+      button = ReadButton.new(data)
+
+      unless button.valid?
+        return button.errors
+      end
+
+      # send request to ShareProgress to read the info about a button
+      begin
+        request = request("read", button.attributes)
+        return request["response"][0]
+      rescue Requests::Error => e
+        return JSON.parse(e.response.body)["message"]
+      end
+    end
   end
 end

data/lib/shareprogress/filters/{new_button.rb → create_button.rb}

@@ -1,4 +1,4 @@
-class NewButton < Scrivener
+class CreateButton < Scrivener
   attr_accessor :key, :page_url, :button_template, :page_title
   attr_accessor :auto_fill, :advanced_options, :variants
 

data/lib/shareprogress/filters/{new_email_variants.rb → create_email_variants.rb}

@@ -1,4 +1,4 @@
-class NewEmailVariants < Scrivener
+class CreateEmailVariants < Scrivener
   attr_accessor :email, :button_template
 
   def validate

data/lib/shareprogress/filters/{new_facebook_variants.rb → create_facebook_variants.rb}

@@ -1,4 +1,4 @@
-class NewFacebookVariants < Scrivener
+class CreateFacebookVariants < Scrivener
   attr_accessor :facebook, :button_template
 
   def validate

data/lib/shareprogress/filters/{new_twitter_variants.rb → create_twitter_variants.rb}

@@ -1,4 +1,4 @@
-class NewTwitterVariants < Scrivener
+class CreateTwitterVariants < Scrivener
   attr_accessor :twitter, :button_template
 
   def validate

data/lib/shareprogress/filters/read_button.rb

@@ -0,0 +1,8 @@
+class ReadButton < Scrivener
+  attr_accessor :key, :id
+
+  def validate
+    assert_present :key
+    assert_present :id
+  end
+end

data/shareprogress.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "shareprogress"
-  s.version = "0.0.2"
+  s.version = "0.1.0"
   s.summary = "Ruby gem to communicate with ShareProgress API"
   s.description = s.summary
   s.authors = ["Cecilia Rivero"]

data/test/create_button_test.rb

@@ -178,7 +178,6 @@ scope do
     assert result == expected_result
   end
 
-  # page_url
   test "create button with empty page_url" do |data|
     data["page_url"] = ""
 
@@ -200,7 +199,6 @@ scope do
     assert result == expected_result
   end
 
-  # page_title
   test "create button with empty page_title" do |data|
     data["page_title"] = ""
 

data/test/read_button_test.rb

@@ -0,0 +1,138 @@
+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"=>12196,
+          "page_url"=>"https://www.sumofus.org/petition/my_petition_slug",
+          "page_title"=>"my_petition_slug-email_button",
+          "button_template"=>"sp_em_small",
+          "share_button_html"=>"<div class='sp_12196 sp_em_small' ></div>",
+          "found_snippet"=>true,
+          "is_active"=>true,
+          "variants"=>{
+            "facebook"=>[{
+              "id"=>48883,
+              "facebook_title"=>nil,
+              "facebook_description"=>nil,
+              "facebook_thumbnail"=>nil}],
+            "email"=>[{
+              "id"=>48881,
+                "email_subject"=>"My Subject 1",
+                "email_body"=>"My Body 1{LINK}"}, {
+              "id"=>48882,
+                "email_subject"=>"My Subject 2",
+                "email_body"=>"My Body 2{LINK}"}],
+            "twitter"=>[{
+              "id"=>48884,
+                "twitter_message"=>nil}]},
+          "advanced_options"=>{
+            "automatic_traffic_routing"=>"true",
+            "buttons_optimize_actions"=>nil,
+            "customize_params"=>nil,
+            "id_pass"=>{
+              "id"=>"id",
+              "passed"=>"referrer_id"}
+          }
+        }],
+        "message"=>nil}
+    end
+  end
+end
+
+setup do
+  {
+    "key" => "ZAkVqgDTSq63_FE6FWeU3g",
+    "id" => "12196"
+  }
+end
+
+scope do
+  # all
+  test "read button successfully" do |data|
+    result = ShareProgress::Button.read(data)
+
+    expected_result = {
+      "id"=>12196,
+      "page_url"=>"https://www.sumofus.org/petition/my_petition_slug",
+      "page_title"=>"my_petition_slug-email_button",
+      "button_template"=>"sp_em_small",
+      "share_button_html"=>"<div class='sp_12196 sp_em_small' ></div>",
+      "found_snippet"=>true,
+      "is_active"=>true,
+      "variants"=>{
+        "facebook"=>[{
+          "id"=>48883,
+          "facebook_title"=>nil,
+          "facebook_description"=>nil,
+          "facebook_thumbnail"=>nil}],
+        "email"=>[{
+          "id"=>48881,
+            "email_subject"=>"My Subject 1",
+            "email_body"=>"My Body 1{LINK}"}, {
+          "id"=>48882,
+            "email_subject"=>"My Subject 2",
+            "email_body"=>"My Body 2{LINK}"}],
+        "twitter"=>[{
+          "id"=>48884,
+          "twitter_message"=>nil}]},
+      "advanced_options"=>{
+        "automatic_traffic_routing"=>"true",
+        "buttons_optimize_actions"=>nil,
+        "customize_params"=>nil,
+        "id_pass"=>{
+          "id"=>"id",
+          "passed"=>"referrer_id"}
+      }
+    }
+
+    assert result == expected_result
+  end
+
+  # key
+  test "read button with nil key" do |data|
+    data["key"] = nil
+
+    result = ShareProgress::Button.read(data)
+
+    expected_result = {:key=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  test "read button with empty key" do |data|
+    data["key"] = ""
+
+    result = ShareProgress::Button.read(data)
+
+    expected_result = {:key=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  # id
+  test "read button with nil id" do |data|
+    data["id"] = nil
+
+    result = ShareProgress::Button.read(data)
+
+    expected_result = {:id=>[:not_present]}
+
+    assert result == expected_result
+  end
+
+  test "read button with empty id" do |data|
+    data["id"] = ""
+
+    result = ShareProgress::Button.read(data)
+
+    expected_result = {:id=>[:not_present]}
+
+    assert result == expected_result
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shareprogress
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Cecilia Rivero
@@ -65,15 +65,17 @@ files:
 - README.md
 - Rakefile
 - lib/shareprogress.rb
-- lib/shareprogress/filters/new_button.rb
-- lib/shareprogress/filters/new_email_variants.rb
-- lib/shareprogress/filters/new_facebook_variants.rb
-- lib/shareprogress/filters/new_twitter_variants.rb
+- lib/shareprogress/filters/create_button.rb
+- lib/shareprogress/filters/create_email_variants.rb
+- lib/shareprogress/filters/create_facebook_variants.rb
+- lib/shareprogress/filters/create_twitter_variants.rb
+- lib/shareprogress/filters/read_button.rb
 - shareprogress.gemspec
 - test/create_button_test.rb
 - test/create_email_button_test.rb
 - test/create_facebook_button_test.rb
 - test/create_twitter_button_test.rb
+- test/read_button_test.rb
 homepage: https://github.com/ceciliarivero/shareprogress-rb
 licenses:
 - MIT