your_membership 1.0.0

data/spec/lib/profile_spec.rb

@@ -0,0 +1,197 @@
+require "spec_helper"
+require "profile"
+
+describe YourMembership::Profile do
+  before do
+    @sample_profile = {
+      "ID"=>"F8C2BEFD-GF37-5CBC-B750-487162B95CDF",
+      "WebsiteID"=>"16273406",
+      "PrimaryGroupCode"=>nil,
+      "IsMember"=>"1",
+      "IsNonMember"=>"0",
+      "Registered"=>"2014-06-12 14:53:30",
+      "LastUpdated"=>"2014-08-07 14:31:34",
+      "ImportID"=>"YM-40539-798958-4242",
+      "ConstituentID"=>nil,
+      "EmailAddr"=>"nflood@echonet.org",
+      "EmailBounced"=>"0",
+      "NamePrefix"=>"Mr",
+      "FirstName"=>"Nate",
+      "MiddleName"=>nil,
+      "LastName"=>"Flood",
+      "NameSuffix"=>nil,
+      "Nickname"=>"Nate Flood",
+      "Gender"=>"M",
+      "Birthdate"=>nil,
+      "MaritalStatus"=>nil,
+      "MaidenName"=>nil,
+      "SpouseName"=>nil,
+      "AnniversaryDate"=>nil,
+      "Employer"=>"ECHO INC.",
+      "Title"=>"Digital Media Specialist",
+      "Profession"=>nil,
+      "Membership"=>"ECHO Interns and Current Staff",
+      "MembershipExpiry"=>nil,
+      "MemberTypeCode"=>"ECHOstaff",
+      "Approved"=>"1",
+      "Suspended"=>"0",
+      "Username"=>"nflood",
+      "PasswordHash"=>"1E10A122BDB35AN022FEJF617BE14527E72KA26E",
+      "AltEmailAddr"=>nil,
+      "HomeAddrLines"=>nil,
+      "HomeCity"=>nil,
+      "HomeLocation"=>nil,
+      "HomePostalCode"=>nil,
+      "HomeCountry"=>nil,
+      "Website"=>nil,
+      "HomePhAreaCode"=>nil,
+      "HomePhone"=>nil,
+      "MobileAreaCode"=>nil,
+      "Mobile"=>nil,
+      "EmpAddrLines"=>"17391 Durrance Road",
+      "EmpCity"=>"North Fort Myers",
+      "EmpLocation"=>"Florida",
+      "EmpPostalCode"=>"33917",
+      "EmpCountry"=>"United States",
+      "BusinessWebsite"=>nil,
+      "EmpPhAreaCode"=>"239",
+      "EmpPhone"=>"567-3355",
+      "EmpFaxAreaCode"=>nil,
+      "EmpFax"=>nil,
+      "LastRenewalReminderSent"=>nil,
+      "GamificationPoints"=>"198",
+      "HeadshotImageURI"=>"http://c.yourmembership.com/sites/echocommunity.site-ym.com/photos/alumni/20140725_144857_16292.jpg",
+      "MasterID"=>nil,
+      "LastRenewalDate"=>"2014-06-12 14:53:00",
+      "ApprovalDate"=>"6/12/2014 2:54:19 PM",
+      "LastModifiedDate"=>"2014-08-07 14:31:34",
+      "QueuedForDelete"=>"0",
+      "QueuedForDeleteDate"=>nil,
+      "Latitude"=>"0",
+      "Longitude"=>"0",
+      "CustomFieldResponses"=>{
+        "CustomFieldResponse"=>[
+          {"Values"=>{"Value"=>"USA"}, "FieldCode"=>"Workingcountry", "Visibility"=>""},
+          {"Values"=>{"Value"=>"other"}, "FieldCode"=>"UserType", "Visibility"=>""},
+          {"Values"=>{"Value"=>"North America"}, "FieldCode"=>"region", "Visibility"=>""},
+          {"Values"=>{"Value"=>["North","South"]}, "FieldCode"=>"PCVenddate", "Visibility"=>""}        ]
+      }
+    }
+  end
+  it "accepts and sets required parameters for new profiles" do
+    profile = YourMembership::Profile.create_new('afirstname', 'alastname', 'amembertypecode', 'ausername', 'apassword')
+    profile.data['FirstName'].should == 'afirstname'
+    profile.data['LastName'].should == 'alastname'
+    profile.data['MemberTypeCode'].should == 'amembertypecode'
+    profile.data['Username'].should == 'ausername'
+    profile.data['Password'].should == 'apassword'
+  end
+
+  it "adds arbitrary keys when creating new profiles" do
+    profile_hash = {'foo' => 'bar'}
+    profile = YourMembership::Profile.create_new('afirstname', 'alastname', 'amembertypecode', 'ausername', nil, profile_hash)
+    profile.data.should include 'foo'
+    profile.data['foo'].should == 'bar'
+  end
+
+  it "adds arbitrary custom keys when creating new profiles" do
+    profile_custom_hash = {'foo' => 'bar'}
+    profile = YourMembership::Profile.create_new('afirstname', 'alastname', 'amembertypecode', 'ausername', nil, {}, profile_custom_hash)
+    profile.custom_data.should include 'foo'
+    profile.custom_data['foo'].should == 'bar'
+  end
+
+  it "creates an object based on a profile hash" do
+    profile = YourMembership::Profile.new(@sample_profile)
+    profile.data.should include 'FirstName'
+  end
+
+  it "adds arbitrary keys when creating based on a profile hash" do
+    profile_hash = {'foo' => 'bar'}
+    profile = YourMembership::Profile.new(profile_hash)
+    profile.data.should include 'foo'
+    profile.data['foo'].should == 'bar'
+  end
+
+  it "returns the output hash when asked" do
+    profile_hash = {'foo' => 'bar'}
+    profile = YourMembership::Profile.new(profile_hash)
+    profile.to_h.should be_a(Hash)
+    profile.to_h.should include 'foo'
+  end
+
+  it "does not return nil values in the output hash" do
+    profile_hash = {'foo' => 'bar', 'far' => nil}
+    profile = YourMembership::Profile.new(profile_hash)
+    profile.to_h.should include 'foo'
+    profile.to_h.should_not include 'far'
+  end
+
+  it "can be manipulated directly through the data attribute" do
+    profile_hash = {'foo' => 'bar'}
+    profile = YourMembership::Profile.new(profile_hash)
+    expect {profile.data['foo'] = 'baz'}.to change{profile.data['foo']}.from('bar').to('baz') 
+  end
+
+  it "has a custom_data attribute" do
+    profile = YourMembership::Profile.new
+    expect profile.should respond_to 'custom_data'
+  end
+
+  it "can be manipulated directly through the custom data attribute" do
+    profile = YourMembership::Profile.new
+    profile.custom_data['foo'] = 'bar'
+    expect profile.custom_data.should include 'foo'
+    expect profile.custom_data['foo'].should == 'bar'
+    expect {profile.custom_data['foo'] = 'baz'}.to change{profile.custom_data['foo']}.from('bar').to('baz') 
+  end
+
+  it "adds a 'CustomFieldResponses' key as a hash" do
+    profile_hash = {'foo' => 'bar'}
+    profile = YourMembership::Profile.new(profile_hash)
+    expect profile.to_h.should include 'CustomFieldResponses'
+    expect profile.to_h['CustomFieldResponses'].should be_a(Hash)
+  end
+
+  it "contains custom_data in the 'CustomFieldResponses' key hash" do
+    profile = YourMembership::Profile.new
+    profile.custom_data['foo'] = 'bar'
+    expect profile.to_h['CustomFieldResponses'].should include 'foo'
+    expect profile.to_h['CustomFieldResponses']['foo'].should == 'bar'
+  end
+
+  it "accepts strings as custom data" do
+    profile = YourMembership::Profile.new
+    profile.custom_data['foo'] = 'bar'
+    expect profile.to_h['CustomFieldResponses']['foo'].should be_a(String)
+  end
+
+  it "accepts arrays as custom data" do
+    profile = YourMembership::Profile.new
+    profile.custom_data['foo'] = ['bar', 'bat', 'baz']
+    expect profile.to_h['CustomFieldResponses']['foo'].should be_a(Array)
+    expect profile.to_h['CustomFieldResponses']['foo'].should include 'baz'
+  end
+
+  it "does not contain nil keys in the 'CustomFieldResponses'" do
+    profile = YourMembership::Profile.new
+    profile.custom_data['foo'] = nil
+    expect profile.to_h['CustomFieldResponses'].should_not include 'foo'
+  end
+
+  it "does not include 'CustomFieldResponses' in the data hash when creating from a profile hash" do
+      profile = YourMembership::Profile.new(@sample_profile)
+      profile.data.should_not include 'CustomFieldResponses'
+  end
+
+  it "puts 'CustomFieldResponses' into the custom_data hash when creating from a profile hash" do
+    profile = YourMembership::Profile.new(@sample_profile)
+    profile.custom_data.should include 'Workingcountry'
+  end
+
+  it "converts 'CustomFieldResponse' values to strings or arrays" do
+    profile = YourMembership::Profile.new(@sample_profile)
+    profile.custom_data.should include 'Workingcountry'
+    profile.custom_data['Workingcountry'].should == "USA"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+#begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = [:expect, :should]
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+#end
+end

data/your_membership.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'your_membership/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "your_membership"
+  spec.version       = YourMembership::VERSION
+  spec.authors       = ["Nate Flood"]
+  spec.email         = ["nflood@echonet.org"]
+  spec.summary       = %q{Ruby SDK for interfacing with the YourMembership.com XML API}
+  spec.description   = %q{The YourMembership member community product offers a wide range of features through its
+    external API. This API is implemented through a specialized set of XML POSTS which is not easily abstracted into a
+    RESTful interface. The purpose of this SDK is to enable Ruby developers and systems using Ruby on Rails to interface
+    natively with the YourMembership.com 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_dependency "httparty", "~>0.13.1"
+  spec.add_dependency "nokogiri", "~>1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: your_membership
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nate Flood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rake
+  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: 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: |-
+  The YourMembership member community product offers a wide range of features through its
+      external API. This API is implemented through a specialized set of XML POSTS which is not easily abstracted into a
+      RESTful interface. The purpose of this SDK is to enable Ruby developers and systems using Ruby on Rails to interface
+      natively with the YourMembership.com API.
+email:
+- nflood@echonet.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/httparty/patch.rb
+- lib/your_membership.rb
+- lib/your_membership/base.rb
+- lib/your_membership/commerce.rb
+- lib/your_membership/config.rb
+- lib/your_membership/convert.rb
+- lib/your_membership/error.rb
+- lib/your_membership/events.rb
+- lib/your_membership/feeds.rb
+- lib/your_membership/member.rb
+- lib/your_membership/members.rb
+- lib/your_membership/people.rb
+- lib/your_membership/profile.rb
+- lib/your_membership/sa.rb
+- lib/your_membership/sa_auth.rb
+- lib/your_membership/sa_certifications.rb
+- lib/your_membership/sa_commerce.rb
+- lib/your_membership/sa_events.rb
+- lib/your_membership/sa_export.rb
+- lib/your_membership/sa_groups.rb
+- lib/your_membership/sa_member.rb
+- lib/your_membership/sa_members.rb
+- lib/your_membership/sa_nonmembers.rb
+- lib/your_membership/sa_people.rb
+- lib/your_membership/session.rb
+- lib/your_membership/version.rb
+- spec/lib/profile_spec.rb
+- spec/spec_helper.rb
+- your_membership.gemspec
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for interfacing with the YourMembership.com XML API
+test_files:
+- spec/lib/profile_spec.rb
+- spec/spec_helper.rb
+has_rdoc: