share_progress 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33f1a306cea9f7dddb34309332f1c21e8c74362b
-  data.tar.gz: 0fd51832efb835b705b1ca5b20b84e834af6e84f
+  metadata.gz: 1085ad215b27e858778f873aec2b0bb199b42cad
+  data.tar.gz: 7b892b06976c903e60cad35a4b18c6ed2235acdf
 SHA512:
-  metadata.gz: 913752b8ebbd327b7300621e16a87f73e3c3905b9e49df8205c76709aa86f46fefcaabdd36537fe233186ee9caba51436b843e322346adbd10fa17851b2b7e60
-  data.tar.gz: 6973aca626b2927a057fa6e7b7d93b0240ea4b5cbfa81aac1cef6275bd916f7d6913d7aacf72427bdd265abab660f7a60212ace6eb733067a4416ac9815f4e2c
+  metadata.gz: 34910b6f8f38ad01cd3843cd95e24ff6d611983ab22d78db2ed894f5736c819206f4098e0bd2e706f920eaa8569a7ae89c7c0242fdf1c0b90037e9ca16e50131
+  data.tar.gz: 58dea5f71910110a3a4acc72abc8f21210d8c2374a5d18a2410b40193e9168e3b66089d2584329ad72b90a427d45f6edb6b2920f1897a4419c8105f848e15539

data/README.md

@@ -1,8 +1,6 @@
 # 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
+`ShareProgress` is a gem designed to make creating A/B tests of Share Buttons for advocacy webpages simple and direct. It wraps the ShareProgress HTTP API while providing a simple, ActiveRecord-like interface for creating, updating and deleting buttons on ShareProgress.org itself.
 
 ## Installation
 
@@ -22,7 +20,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The current version of `share_progress` is centered around `Button` and `Variant` classes. Currently, this gem wraps a subset of the [ShareProgress API](https://docs.google.com/document/d/1f1Jktt4gk9b3qugH8h-3bj6DoijQ3_6-RxUw5uq7DWU/edit#) intended to work within applications that need to create share buttons for use on their website. 
+
+Before beginning, the application will expect that your environment defines an Environment Variable named `SHARE_PROGRESS_API_KEY`. This key can be retrieved for your account from run.shareprogress.org. 
+
+`ShareProgress` defines an API for interacting with the button portion of the ShareProgress API that is similar to ActiveRecord. Creating a new button is as simple as calling `Button.new(params)` where the params in question are the variables of the button (see [Button parameter options](https://docs.google.com/document/d/1f1Jktt4gk9b3qugH8h-3bj6DoijQ3_6-RxUw5uq7DWU/edit#heading=h.66d9v1vnsmth) for more details). Button variants (which define A/B/X testing variants for testing share options on ShareProgress) can be added by setting the `variants` property of your created button, or added through the `add_or_update(variant)` method. Button variants can be defined as hashes containing the correct parameters (options for Variant values can be seen in the sample request in [the documentation](https://docs.google.com/document/d/1f1Jktt4gk9b3qugH8h-3bj6DoijQ3_6-RxUw5uq7DWU/edit#heading=h.mdykzbbhavff)) or by passing in instances of the `FacebookVariant`, `TwitterVariant` and `EmailVariant` classes. 
+
+To create or update your button and its variants, simply call `button.save`, which will marshal all your changes and submit them to the API. If the request is successful, `save` will return `true`, while errors will cause the method to return `false` and `button.errors` will contain the relevant errors on the save attempt.
+
+**Note**: The API currently includes options for `destroy` on variants, which will, when complete, allow you to remove a variant from a button after that button has been saved. This is currently an experimental feature. It is not tested and unlikely to work reliably, if at all. These features should not be used in production.
 
 ## Development
 
@@ -32,7 +38,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/share_progress.
+Bug reports and pull requests are welcome on GitHub at https://github.com/SumOfUs/share_progress.
 
 
 ## License

data/lib/share_progress/client.rb

@@ -20,12 +20,22 @@ module ShareProgress
       private
 
       def format_response(http_response)
+        check_api_error(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
 
+      def check_api_error(http_response)
+        return if http_response.code < 300
+        return if http_response.code == 404 || http_response.code == 422
+        error_msg = "Status #{http_response.code}: #{http_response['message']}\n" +
+                    "Requesting: #{http_response.request.uri.to_s}\n" +
+                    "With Body: #{http_response.request.raw_body}"
+        raise ApiError.new(error_msg)
+      end
+
     end
   end
 end

data/lib/share_progress/errors.rb

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

data/lib/share_progress/version.rb

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

data/share_progress.gemspec

@@ -27,7 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'gem-release'
 
   # Runtime Dependencies
-  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'httparty', '>= 0.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: share_progress
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Neal Donnelly
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,19 +82,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  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.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
 description: 
 email:
 - NealJMD@gmail.com