constantcontact-ruby 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74ceb09ee19f5f7af57343c79fc8ef94416a1ae1
+  data.tar.gz: 1ca40a24f720b500e490b8bcccdb3f54da184075
+SHA512:
+  metadata.gz: 1f9e336a081468da87bfe1ba9cef99434083421030da104098f4cc67d13b5d65e89bb35067123b0ce518c046a56a841d4e6c113c0d61762d965db412b1fa7668
+  data.tar.gz: c1d534fe869dc559ec6f6751ef7e7e17f3ba1b4b24b53cbd9a7d986ddc7a2ded8ec8478155760e25c07e3e53c88f904552826a76ed795bba80688843764df653

data/.rspec

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

data/README.md

@@ -0,0 +1,136 @@
+Constant Contact Ruby SDK for AppConnect
+====
+
+The Ruby SDK for AppConnect allows you to leverage the AppConnect v2 APIs.
+
+[![Build Status](https://travis-ci.org/constantcontact/ruby-sdk.png)](https://travis-ci.org/constantcontact/ruby-sdk)
+
+Installation
+====
+Via bundler:
+```ruby
+gem 'constantcontact', '~> 2.2.0'
+```
+Otherwise:
+```bash
+[sudo|rvm] gem install constantcontact
+```
+
+Configuration
+====
+The AppConnect SDK can be configured with some options globally or they can be specified when creating the API client:
+```ruby
+ConstantContact::Util::Config.configure do |config|
+  config[:auth][:api_key] = 'your-access-key'
+  config[:auth][:api_secret] = 'your-access-secret'
+  config[:auth][:redirect_uri] = 'https://example.com/auth/constantcontact'
+end
+```        
+
+Documentation
+=====
+SDK Documentation is hosted at http://constantcontact.github.io/ruby-sdk
+
+API Documentation is located at http://developer.constantcontact.com/docs/developer-guides/api-documentation-index.html
+
+Getting Started
+====
+AppConnect requires an OAuth access token which will give your app access to Constant Contact data and services for the accout that granted that access token.
+
+Rails
+=====
+Create a new controller action.  The redirect_url should be the same as the one given when registering the app with Mashery. Use the following code snippet to get an access token:
+```ruby
+@oauth = ConstantContact::Auth::OAuth2.new(
+  :api_key => 'your api key',
+  :api_secret => 'your secret key',
+  :redirect_url => 'your redirect url' # the URL given when registering your app with Mashery.
+)
+
+@error = params[:error]
+@user = params[:username]
+@code = params[:code]
+
+if @code.present?
+  response = @oauth.get_access_token(@code)
+  if response.present?
+    token = response['access_token']
+    cc = ConstantContact::Api.new('your api key', token)
+    @contacts = cc.get_contacts()
+  end
+else
+  # if not code param is provided redirect into the OAuth flow
+  redirect_to @oauth.get_authorization_url and return
+end
+```
+
+Create a view for the above mentioned action with the following code:
+```erb
+
+<% if @error %>
+  <p><%= @error %></p>
+<% end %>
+
+<% if @contacts.present? %>
+  <% @contacts.each do |contact| %>
+    <p>Contact name: <%= "#{contact.first_name} #{contact.last_name}" %></p>
+  <% end %>
+<% end %>
+```
+
+The first time you access the action you will be redirected into the Constant Contact OAuth flow.
+Then you will be redirected back to your action and you should see the list of contacts.
+
+Sinatra
+=====
+Require AppConnect:
+```ruby
+require 'constantcontact'
+```
+
+Add the following route.  The redirect_url should be the same given when registering the app with Mashery.
+```ruby
+get '/my_url' do
+  @oauth = ConstantContact::Auth::OAuth2.new(
+    :api_key => 'your api key',
+    :api_secret => 'your secret key',
+    :redirect_url => 'your redirect url'
+  )
+
+  @error = params[:error]
+  @user = params[:username]
+  @code = params[:code]
+
+  if @code
+    response = @oauth.get_access_token(@code)
+    if response
+      token = response['access_token']
+      cc = ConstantContact::Api.new('your api key', token)
+      @contacts = cc.get_contacts()
+    end
+  end
+
+  erb :my_view
+end
+```
+
+Create a my_view.erb with the following code:
+```ruby
+<% if @error %>
+  <p><%=@error%></p>
+<% end %>
+
+<% if @code %>
+  <% if @contacts %>
+    <% @contacts.each do |contact| %>
+      <p>\Contact name: <%= "#{contact.first_name} #{contact.last_name}" %></p>
+    <% end %>
+  <% end %>
+<% else %>
+  <a href="<%=@oauth.get_authorization_url%>">Click to authorize</a>
+<% end %>
+```
+
+The first time you access the action in browser you should see the "Click to authorize" link.
+Follow the link, go through all the Constant Contact steps required 
+and then you will be redirected back to your action and you should see the list of contacts.

data/constantcontact-ruby.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name = "constantcontact-ruby"
+  s.version = '2.2.0'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["ConstantContact", "ConferenceCloud"]
+  s.homepage = "http://www.constantcontact.com"
+  s.summary = %q{Constant Contact SDK for Ruby}
+  s.email = "webservices@constantcontact.com"
+  s.description = "Ruby library for interactions with Constant Contact v2 API"
+  s.license = "MIT"
+
+  s.files = [
+    '.rspec',
+    'constantcontact-ruby.gemspec',
+    'README.md'
+  ]
+  s.files += Dir['lib/**/*.rb']
+  s.executables = []
+  s.require_paths = [ "lib" ]
+  s.test_files = Dir['spec/**/*_spec.rb']
+  
+  s.add_runtime_dependency("rest-client", '~> 1.6', '>= 1.6.7')
+  s.add_runtime_dependency("json", '~> 1.8', '>= 1.8.1')
+  s.add_runtime_dependency('mime-types', '~> 2.4', '>= 2.4.1')
+  s.add_development_dependency("rspec", '~> 2.14')
+end