newsletter7_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3284c30e56d4e70c3f4ebd0eee84670c97c02c0b
+  data.tar.gz: 1b01a9c23cfcf5416886494f77c39e22ef90cb89
+SHA512:
+  metadata.gz: 487f70c8a71847c7dca47d9d337a4552c158db75172dcc5f7f6aedda42f9c7276a31e51a80a2c6be0bab9fbe656846b7a1f4611167dcfdbf01b3f218c6cbc633
+  data.tar.gz: 1376387e69529b71706e85a94aeb8135781355d5ac36ee903a4ac8324d368676eeea582dc5d250ee6916896405db0342b03bd0b26289c0ed44ffd711df4f6eb0

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in newsletter7_api.gemspec
+gemspec
+
+gem 'rails', group: :test

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 siera
+
+MIT License
+
+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,124 @@
+# Newsletter7Api
+
+This is a API interface to export email contact_group to Newsletter7. Accounts signed up Newsletter7 with Bonofa account can export Newsletter7 email contact_group directly on Bonofa sites.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'newsletter7_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install newsletter7_api
+
+## Usage
+
+You can use ContactGroup resources as normal models.
+
+```ruby
+Newsletter7ApiResource.connection.set_header('ACCESS_TOKEN', account_promotion_code)
+@contact_group = Newsletter7Api::ContactGroup.new(name: '', contacts: [])
+
+@your_contact_group = ...
+@your_contact_group.each do |member|
+  @contact_group.contacts << member
+end
+
+@contact_group.save
+```
+
+This will create a contact_group on Newsletter7.(Imagine memeber has attributes first_name, last_name, email)
+
+### Configuration
+
+You can configure Newsletter7 api url and http authentication name and password in initializer(config/initializers/newsletter7_api.rb)
+
+```ruby
+Newsletter7ApiResource.site = 'http://localhost:3000/api/v1'
+Newsletter7ApiResource.user = 'newsletter7'
+Newsletter7ApiResource.password = 'defaultpw'
+```
+
+This settings should be match with those of Newsletter7.
+
+Account promotion code will be encrypted and set in request header as access token. This promotion code will be used to find Newsletter7 account.
+
+
+### Using Example
+
+Coltroller code can be look like this;
+
+```ruby
+class ContactGroupsController < ApplicationController
+
+  newsletter7_api
+
+  def new
+    begin
+      @contact_group = Newsletter7Api::ContactGroup.all
+    rescue => e
+      redirect_to root_path, alert: 'You are not authorized to access Newsletter7.'
+      return
+    end
+
+    @your_contact_group = ...
+
+    @your_contact_group.each do |member|
+      @contact_group.contacts << member
+    end
+  end  
+
+  def create
+    @contact_group = Newsletter7Api::ContactGroup.new(params[:newsletter7_api_contact_group])
+
+    if @contact_group.save
+      redirect_to root_path, notice: 'Contacts were successfully exported.'
+    else
+      redirect_to root_path, alert: 'Error occured while exporting contacts.'
+    end
+  end
+end
+```
+
+Form example(haml)
+
+```ruby
+= form_for(@contact_group, url: url_for(:action => 'create')) do |f|
+  %fieldset
+    = f.label :name
+    = f.text_field :name
+
+    %h4
+      Contacts to export
+      %small (member with invalid email or not selected will not be exported.)
+    = render partial: 'contact', collection: @contact_group.contacts
+          
+  = f.submit
+```
+
+Contact partial
+
+```ruby
+.contact_field
+  %fieldset
+    = text_field_tag "newsletter7_api_contact_group[contacts][][first_name]", contact.first_name, placeholder: 'First Name'
+  %fieldset
+    = text_field_tag "newsletter7_api_contact_group[contacts][][last_name]", contact.last_name, placeholder: 'Last Name'
+  %fieldset
+    = text_field_tag "newsletter7_api_contact_group[contacts][][email]", contact.email, placeholder: 'Email'
+  %fieldset
+    = check_box_tag "newsletter7_api_contact_group[contacts][][selected]", true, checked: true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/c7devteam/newsletter7_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require 'bundler'

data/app/controllers/newsletter7_api_controller.rb

@@ -0,0 +1,19 @@
+module Newsletter7ApiController
+
+  module ClassMethods
+
+    def newsletter7_api(opts={})
+      before_filter { generate_access_token(opts) }
+    end
+  end
+
+
+  module InstanceMethods
+
+    private
+
+    def generate_access_token(opts={})
+      Newsletter7ApiResource.connection.set_header('ACCESS_TOKEN', current_account.promotion_code)
+    end
+  end
+end

data/lib/newsletter7_api.rb

@@ -0,0 +1,4 @@
+require "newsletter7_api/version"
+require "newsletter7_api/newsletter7_api_resource"
+require "newsletter7_api/contact_group"
+require "newsletter7_api/engine"

data/lib/newsletter7_api/contact_group.rb

@@ -0,0 +1,7 @@
+module Newsletter7Api
+
+  class ContactGroup < Newsletter7ApiResource
+
+  end
+end
+

data/lib/newsletter7_api/engine.rb

@@ -0,0 +1,13 @@
+module Newsletter7Api
+  
+  class Engine < ::Rails::Engine
+
+    initializer 'newsletter7_api.controller' do
+
+      ActiveSupport.on_load(:action_controller) do
+        include Newsletter7ApiController::InstanceMethods
+        extend Newsletter7ApiController::ClassMethods
+      end
+    end
+  end
+end

data/lib/newsletter7_api/newsletter7_api_resource.rb

@@ -0,0 +1,18 @@
+require 'active_resource'
+require 'encryptor'
+
+
+class Newsletter7ApiResource < ActiveResource::Base
+  self.site = "http://localhost:3000/api/v1"
+  self.user = "newsletter7"
+  self.password = "defaultpw"
+end
+
+
+class ActiveResource::Connection
+  alias :static_default_header :default_header
+
+  def set_header(key, value)
+    default_header.update(key => Base64.encode64(Encryptor.encrypt(value: value, key: Newsletter7ApiResource.password)))
+  end
+end

data/lib/newsletter7_api/version.rb

@@ -0,0 +1,4 @@
+module Newsletter7Api
+
+  VERSION = "0.1.1"
+end

data/newsletter7_api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'newsletter7_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "newsletter7_api"
+  spec.version       = Newsletter7Api::VERSION
+  spec.authors       = ["siera"]
+  spec.email         = ["sieraruo@gmail.com"]
+  spec.summary       = %q{Newsletter7 API client}
+  spec.description   = %q{Newsletter7 API client can export contacts to Newsletter7 site easily using newsletter7_api}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activeresource', '~> 4.0', '>= 4.0.0'
+  spec.add_runtime_dependency 'encryptor', '~> 1.3', '>= 1.3.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rspec'
+end

data/spec/newsletter7_api_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe "Newsletter7Api" do
+
+  describe "Newsletter7ApiResource" do
+
+    it "should set site" do
+      expect(Newsletter7ApiResource.site.to_s).to eq('http://localhost:3000/api/v1')
+    end
+
+    it "should set user" do
+      expect(Newsletter7ApiResource.user).to eq('newsletter7')
+    end
+
+    it "should set password" do
+      expect(Newsletter7ApiResource.password).to eq('defaultpw')
+    end
+  end
+
+  describe "ContactGroup" do
+
+    before do
+      @contact_groups  = [{ name: 'Bonofa Group', description: 'test' }].to_json
+      @contact_group = { name: 'Bonofa Group', contacts: [{first_name: 'first_name', last_name: 'last_name', email: 'test@test.com'}] }.to_json
+
+      ActiveResource::HttpMock.respond_to do |mock|
+        mock.get    "/api/v1/contact_groups.json", {"Authorization"=>"Basic bmV3c2xldHRlcjc6ZGVmYXVsdHB3", "Accept"=>"application/json"}, @contact_groups
+        mock.post   "/api/v1/contact_groups.json", {"Authorization"=>"Basic bmV3c2xldHRlcjc6ZGVmYXVsdHB3", "Content-Type"=>"application/json"}, @contact_group, 201
+      end
+    end
+
+    it "should fetch contact groups" do
+      contact_groups = Newsletter7Api::ContactGroup.all
+      expect(contact_groups).to be_a(ActiveResource::Collection)
+    end
+
+    it "should save contacts" do
+      contact_group = Newsletter7Api::ContactGroup.new({name: 'Bonofa Group', contacts: [{first_name: 'first_name', last_name: 'last_name', email: 'test@test.com'}]})
+      contact_group.save
+      expect(contact_group.name).to eq('Bonofa Group')
+    end
+  end
+
+  describe "Controller" do
+
+    describe "before filter" do
+
+      it "should generate access token in header" do
+        expect(Newsletter7ApiResource.connection.set_header('ACCESS_TOKEN', 'promotion_code')).to eq({"ACCESS_TOKEN"=>"#{Base64.encode64(Encryptor.encrypt(value: 'promotion_code', key: 'defaultpw'))}"})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rails'
+require 'newsletter7_api'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: newsletter7_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- siera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: encryptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Newsletter7 API client can export contacts to Newsletter7 site easily
+  using newsletter7_api
+email:
+- sieraruo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/newsletter7_api_controller.rb
+- lib/newsletter7_api.rb
+- lib/newsletter7_api/contact_group.rb
+- lib/newsletter7_api/engine.rb
+- lib/newsletter7_api/newsletter7_api_resource.rb
+- lib/newsletter7_api/version.rb
+- newsletter7_api.gemspec
+- spec/newsletter7_api_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Newsletter7 API client
+test_files:
+- spec/newsletter7_api_spec.rb
+- spec/spec_helper.rb
+has_rdoc: