share_progress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33f1a306cea9f7dddb34309332f1c21e8c74362b
+  data.tar.gz: 0fd51832efb835b705b1ca5b20b84e834af6e84f
+SHA512:
+  metadata.gz: 913752b8ebbd327b7300621e16a87f73e3c3905b9e49df8205c76709aa86f46fefcaabdd36537fe233186ee9caba51436b843e322346adbd10fa17851b2b7e60
+  data.tar.gz: 6973aca626b2927a057fa6e7b7d93b0240ea4b5cbfa81aac1cef6275bd916f7d6913d7aacf72427bdd265abab660f7a60212ace6eb733067a4416ac9815f4e2c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+*.iml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Neal Donnelly
+
+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,41 @@
+# ShareProgress
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/share_progress`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'share_progress'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install share_progress
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/share_progress.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "share_progress"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/share_progress/button.rb

@@ -0,0 +1,124 @@
+require 'share_progress'
+require 'share_progress/client'
+require 'share_progress/utils'
+require 'share_progress/errors'
+require 'share_progress/variant_collection'
+
+module ShareProgress
+  class Button
+
+    attr_accessor :page_url, :page_title, :button_template, :share_button_html, :is_active, :auto_fill, :variants, :advanced_options, :include, :id
+    attr_reader   :errors
+
+    class << self
+
+      def create(page_url:, button_template:, **options)
+        created = update(options.merge(page_url: page_url, button_template: button_template))
+        created.nil? ? new({}) : new(created)
+      end
+
+      # this method is used by instance.save and Button.create
+      def update(options={})
+        Utils.filter_keys(options, allowed_keys)
+        Utils.filter_keys(options[:advanced_options], advanced_options_keys)
+        created = Client.post endpoint('update'), { body: options }
+        created[0] # the API returns a list of length 1
+      end
+
+      def find(id)
+        matches = Client.get endpoint('read'), { query: { id: id } }
+        raise RecordNotFound.new("No button exists with id #{id}") if matches.size < 1
+        new(matches[0])
+      end
+
+      def destroy(id)
+        deleted = Client.post endpoint('delete'), { query: { id: id } }
+        (deleted.size > 0)
+      end
+
+      def all(limit: 100, offset: 0)
+        matches = Client.get endpoint, { query: { limit: limit, offset: offset } }
+        matches.map{ |match| new(match) }
+      end
+
+      def allowed_keys
+        optional_keys + required_keys
+      end
+
+      private
+
+      def endpoint(method=nil)
+        extension = method.nil? ? "" : "/#{method}"
+        "/buttons#{extension}"
+      end
+
+      # currently no validation, but worth noting that they're different
+      def required_keys
+        [:page_url, :button_template]
+      end
+
+      def optional_keys
+        [:id, :page_title, :auto_fill, :variants, :advanced_options, :share_button_html, :is_active, :errors]
+      end
+
+      def advanced_options_keys
+        [:automatic_traffic_routing, :buttons_optimize_actions, :custom_params, :prompt]
+      end
+    end
+
+    def initialize(params)
+      @variant_collection = VariantCollection.new
+      update_attributes(params)
+    end
+
+    def update_attributes(params)
+      params = Utils.symbolize_keys(params)
+      params.each_pair do |key, value|
+        instance_variable_set("@#{key}", value) unless key == :variants
+      end
+      self.variants = params[:variants] if params.include? :variants
+    end
+
+    def save
+      result = self.class.update(serialize)
+      update_attributes(result)
+      (errors.size == 0)
+    end
+
+    def variants=(variants)
+      @variant_collection.update_variants(variants)
+    end
+
+    def variants
+      @variant_collection.serialize
+    end
+
+    def add_or_update_variant(variant)
+      @variant_collection.add_or_update(variant)
+    end
+
+    def remove_variant(variant)
+      @variant_collection.remove(variant)
+    end
+
+    def find_variant(variant)
+      @variant_collection.find(variant)
+    end
+
+    def destroy
+      self.class.destroy(id) ? self : false
+    end
+
+    private
+
+    def serialize
+      serialized = Hash.new
+      self.class.allowed_keys.each do |key|
+        value = send(key)
+        serialized[key] = value unless value.nil?
+      end
+      serialized
+    end
+
+  end
+end

data/lib/share_progress/client.rb

@@ -0,0 +1,31 @@
+require 'httparty'
+
+module ShareProgress
+  class Client
+    include HTTParty
+
+    base_uri 'run.shareprogress.org/api/v1'
+    default_params key: ENV['SHARE_PROGRESS_API_KEY']
+
+    class << self
+
+      def get(*args)
+        format_response(super(*args))
+      end
+
+      def post(*args)
+        format_response(super(*args))
+      end
+
+      private
+
+      def format_response(http_response)
+        formatted = http_response['response'].nil? ? [] : http_response['response']
+        errors = http_response['success'] ? {} : http_response['message']
+        formatted.each { |r| r['errors'] = errors }
+        formatted
+      end
+
+    end
+  end
+end

data/lib/share_progress/email_variant.rb

@@ -0,0 +1,17 @@
+require 'share_progress'
+require 'share_progress/variant'
+
+module ShareProgress
+  class EmailVariant < Variant
+
+    def self.type
+      'email'
+    end
+
+    def self.fields
+      [:email_subject, :email_body]
+    end
+
+    attr_accessor *fields
+  end
+end

data/lib/share_progress/errors.rb

@@ -0,0 +1,6 @@
+module ShareProgress
+  class ShareProgressError < StandardError; end
+  class RecordNotFound < ShareProgressError; end
+  class AnalyticsNotFound < ShareProgressError; end
+  class CouldNotParseVariant < ShareProgressError; end
+end

data/lib/share_progress/facebook_variant.rb

@@ -0,0 +1,17 @@
+require 'share_progress'
+require 'share_progress/variant'
+
+module ShareProgress
+  class FacebookVariant < Variant
+
+    def self.type
+      'facebook'
+    end
+
+    def self.fields
+      [:facebook_title, :facebook_description, :facebook_thumbnail]
+    end
+
+    attr_accessor *fields
+  end
+end

data/lib/share_progress/twitter_variant.rb

@@ -0,0 +1,17 @@
+require 'share_progress'
+require 'share_progress/variant'
+
+module ShareProgress
+  class TwitterVariant < Variant
+
+    def self.type
+      'twitter'
+    end
+
+    def self.fields
+      [:twitter_message]
+    end
+
+    attr_accessor *fields
+  end
+end

data/lib/share_progress/utils.rb

@@ -0,0 +1,20 @@
+require 'httparty'
+
+module ShareProgress
+  class Utils    
+    class << self
+
+      def filter_keys(params, acceptable)
+        return params if params.nil?
+        params.select!{ |key, _| acceptable.include? key }
+      end
+
+      def symbolize_keys(params)
+        fresh = Hash.new
+        params.each_pair{ |k, v| fresh[k.to_sym] = v }
+        fresh
+      end
+
+    end
+  end
+end

data/lib/share_progress/variant.rb

@@ -0,0 +1,107 @@
+require 'share_progress'
+require 'share_progress/client'
+require 'share_progress/errors'
+require 'share_progress/button'
+
+module ShareProgress
+  class Variant
+    attr_accessor :button, :id
+    attr_reader   :errors, :_destroy
+
+    def initialize(params=nil)
+      update_attributes(params) unless params.nil?
+    end
+
+    def to_s
+      self.serialize.to_json
+    end
+
+    def save
+      add_error('button', "can't be blank") and return false if @button.nil?
+      add_error('button', "must have an id") and return false if @button.id.nil?
+      response = Button.update(id: @button.id, variants: {type => [serialize]})
+      return false unless response.is_a? Hash
+
+      @errors = parse_errors(response['errors'])
+      (@errors.size == 0)
+    end
+
+    def destroy
+      add_error('id', "can't be blank") and return false if id.nil?
+      @_destroy = true
+      saved = save
+      @_destroy = nil
+      saved ? self : false
+    end
+
+    def serialize
+      serialized = Hash.new
+      all_fields.each do |field|
+        value = send(field)
+        serialized[field] = value unless (value.nil? and field == :_destroy)
+      end
+      serialized
+    end
+
+    def update_attributes(params)
+      if params.is_a? Variant
+        params.instance_variables.each do |key|
+          instance_variable_set(key, params.instance_variable_get(key))
+        end
+      elsif params.is_a? Hash
+        Utils.symbolize_keys(params).each_pair do |key, value|
+          @button = value if key == :button
+          instance_variable_set("@#{key}", value) if all_fields.include? key
+        end
+      end
+    end
+
+    def all_fields
+      self.class.fields + [:id, :_destroy]
+    end
+
+    def type
+      self.class.type
+    end
+
+    def set_analytics(analytics:)
+      # Thinking at the moment that it makes sense to keep this as a basic hash, though
+      # we might need to extend its functionality down the road.
+      @analytics = analytics
+    end
+
+    def analytics
+      if @analytics
+        @analytics
+      else
+        raise AnalyticsNotFound
+      end
+    end
+
+    private
+
+    def add_error(field, message)
+      @errors ||= {}
+      @errors[field.to_s] ||= []
+      @errors[field.to_s].push(message)
+    end
+
+    def parse_errors(errors)
+      begin
+        messages = errors['variants'][0]
+        return {} if messages.nil?
+      rescue NoMethodError, KeyError, IndexError
+        return {}
+      end
+      # it concatenates the field and the error into a full message
+      output = {}
+      messages.map{|msg| msg.split(' ', 2)}.each do |field, error|
+        output[field] ||= []
+        output[field].push error
+      end
+      output
+    end
+
+  end
+end
+

data/lib/share_progress/variant_collection.rb

@@ -0,0 +1,94 @@
+require 'share_progress/variant'
+require 'share_progress/variant_parser'
+
+module ShareProgress
+  class VariantCollection
+
+    def initialize(variants_hash=nil)
+      @variants = []
+      update_variants(variants_hash) unless variants_hash.nil?
+    end
+
+    def update_variants(variants_hash)
+      survivors = []
+      variants_hash.each_pair do |variant_type, variants_list|
+        variants_list.each do |variant_hash|
+          added = add_or_update(variant_hash)
+          survivors.push(added)
+        end
+      end
+      @variants.select!{ |v| survivors.include? v }
+    end
+
+    def serialize
+      serialized = {}
+      @variants.each do |variant_obj|
+        type_name = variant_obj.type.to_sym
+        serialized[type_name] ||= []
+        serialized[type_name].push variant_obj.serialize
+      end
+      serialized
+    end
+
+    def add_or_update(variant)
+      variant_obj = find(variant)
+      if variant_obj.nil?
+        if variant.is_a? Variant
+          @variants.push variant
+          variant_obj = variant
+        else
+          variant_obj = create_variant(variant)
+          @variants.push(variant_obj)
+        end
+      else
+        variant_obj.update_attributes(variant)
+      end
+      variant_obj
+    end
+
+    def remove(variant)
+      target = find(variant)
+      destroyed = target.destroy
+      return false if destroyed == false
+      @variants.select!{ |v| v.id != target.id }
+      destroyed
+    end
+
+    def variants
+      @variants
+    end
+
+    def find(mystery_variant)
+      if mystery_variant.is_a? Variant
+        find_variant_by_obj(mystery_variant)
+      elsif mystery_variant.is_a? Hash
+        find_variant_by_id(Utils.symbolize_keys(mystery_variant)[:id])
+      elsif mystery_variant.is_a? Fixnum
+        find_variant_by_id(mystery_variant)
+      end
+    end
+
+    private
+
+    def create_variant(variant_hash)
+      VariantParser.parse(variant_hash).new(variant_hash)
+    end
+
+    def find_variant_by_obj(variant_obj)
+      matching = @variants.select{ |candidate| candidate == variant_obj}
+      if matching.size > 0
+        matching[0]
+      elsif variant_obj.id
+        find_variant_by_id(variant_obj.id)
+      else
+        nil
+      end
+    end
+
+    def find_variant_by_id(id)
+      matching = @variants.select{ |candidate| candidate.id == id }
+      matching.size > 0 ? matching[0] : nil
+    end
+
+  end
+end

data/lib/share_progress/variant_parser.rb

@@ -0,0 +1,24 @@
+require 'share_progress'
+require 'share_progress/errors'
+require 'share_progress/email_variant'
+require 'share_progress/facebook_variant'
+require 'share_progress/twitter_variant'
+
+module ShareProgress
+  class VariantParser
+
+    def self.parse(hash_to_parse)
+      keys = hash_to_parse.keys.map(&:to_sym)
+      match = nil
+      [FacebookVariant, EmailVariant, TwitterVariant].each do |variant_class|
+        if (keys & variant_class.fields).size > 0 # & is array intersection
+          raise CouldNotParseVariant unless match.nil? # only match one class
+          match = variant_class
+        end
+      end
+      raise CouldNotParseVariant if match.nil?
+      match
+    end
+
+  end
+end

data/lib/share_progress/version.rb

@@ -0,0 +1,3 @@
+module ShareProgress
+  VERSION = "0.1.0"
+end

data/lib/share_progress.rb

@@ -0,0 +1,6 @@
+require "share_progress/version"
+require "share_progress/button"
+require 'httparty'
+
+module ShareProgress
+end

data/share_progress.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'share_progress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'share_progress'
+  spec.version       = ShareProgress::VERSION
+  spec.authors       = ['Neal Donnelly', 'Eric Boersma']
+  spec.email         = ['NealJMD@gmail.com', 'eric.boersma@gmail.com']
+
+  spec.summary       = %q{A simple gem designed for creating and retrieving buttons and data on ShareProgress.org}
+  spec.homepage      = 'https://github.com/SumOfUs/share_progress'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # ruby version for required named parameters
+  spec.required_ruby_version = '>= 2.1'
+
+  # Development Dependencies
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+
+  # Runtime Dependencies
+  spec.add_runtime_dependency 'httparty'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: share_progress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neal Donnelly
+- Eric Boersma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- NealJMD@gmail.com
+- eric.boersma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/share_progress.rb
+- lib/share_progress/button.rb
+- lib/share_progress/client.rb
+- lib/share_progress/email_variant.rb
+- lib/share_progress/errors.rb
+- lib/share_progress/facebook_variant.rb
+- lib/share_progress/twitter_variant.rb
+- lib/share_progress/utils.rb
+- lib/share_progress/variant.rb
+- lib/share_progress/variant_collection.rb
+- lib/share_progress/variant_parser.rb
+- lib/share_progress/version.rb
+- share_progress.gemspec
+homepage: https://github.com/SumOfUs/share_progress
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A simple gem designed for creating and retrieving buttons and data on ShareProgress.org
+test_files: []