mindbody-api 1.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 177b54dfe5a26b025296433fc1feac2a0718c3b6
+  data.tar.gz: 8fa1c5cd465d3e65925bbb651c2ffe651543c5cd
+SHA512:
+  metadata.gz: 0670b56e47509479b718e6381bbd09ee5781b9174b53588d487433acebd0dd11fe290190889f5363d20becc217885265bdffeaef11119d0d81aa30dcddb7bdd2
+  data.tar.gz: cfed01706925dcd97a82b9caa2fc19920167e390a75cad18763f48b4da15d6bd0c9c850b3cf807041d298c9b8739fde6cfa81f1b6df764d1829dc454d2783cfd

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv-version
+.ruby-version
+.env

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contributing
+
+## Guidelines:
+
+* All changes should be in a topic branch
+* All changes should have appropriate test coverage
+* 2 spaces (not tabs) for indention
+* Travis builds must be green prior to merging
+
+## Steps:
+
+1. Fork it
+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 new Pull Request

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mindbody-api.gemspec
+gemspec
+
+# For guard
+gem 'rb-inotify', :require => false
+gem 'rb-fsevent', :require => false
+gem 'rb-fchange', :require => false
+
+# To pick up the .env file
+gem 'dotenv'

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/mindbody-api/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stafford Brunk
+
+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,79 @@
+# MindBody API
+
+Provides a Ruby interface to the [MindBody API](http://www.mindbodyonline.com/api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mindbody-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mindbody-api
+
+## Configuration
+
+You must set your MindBody source name, key, and site ids. These values are accessible via the [MindBody Partner Page](https://api.mindbodyonline.com/Home/LogIn)
+
+The easiest way to set these is via three environment variables: `MINDBODY_SOURCE_NAME`, `MINDBODY_SOURCE_KEY`, and `MINDBODY_SITE_IDS`. `MINDBODY_SITE_IDS` can have any delimiter.
+
+Alternatively, you may set them in an initializer:
+
+    MindBody.configure do |config|
+      config.site_ids    = -99
+      config.source_key  = 'abcd1234'
+      config.source_name = 'SuperFoo'
+      config.log_level   = :info # Savon logging level. Default is :debug, options are [:debug, :info, :warn, :error, :fatal]
+    end
+
+See http://savonrb.com/version2/globals.html for more information on the logging
+setting.
+
+## Usage
+
+`mindbody-api` is laid out into two distinct parts: [services](https://github.com/wingrunr21/mindbody-api/tree/master/lib/mindbody-api/services) and [models](https://github.com/wingrunr21/mindbody-api/tree/master/lib/mindbody-api/models)
+
+### Services
+
+The services are direct mirrors of those documented by MindBody in their [API
+documentation](https://api.mindbodyonline.com/Doc). Required data arguments for
+each service call are defined as arguments for the Ruby methods. Optional
+arguments should be passed as a string based hash. For example:
+
+    client_id = 1234
+    response = MindBody::Services::ClientService.get_client_visits(client_id, 'StartDate' => Date.today, 'EndDate' => Date.today)
+    result = response.result
+    visits = result[:visits]
+
+If any of the service calls need to be passed in a list of something (eg `Int32`
+or `Int64`) then the option needs to be specified like this:
+
+    MindBody::Services::StaffService.get_staff('StaffIDs' => {'long' => [123415123, 123123213]})
+
+### Models
+
+When a request comes back from MindBody, the various data types are hydrated
+into models that are defined in the `MindBody::Models` namespace.
+
+## Versioning
+
+In theory the gem would track the version of the MindBody API. In practice their
+version number does not increment in a way that would make sense for a rubygem.
+So, the gem itself uses [semver](http://semver.org/) and makes available a
+constant `API_VERSION` that stores the version of the MindBody API.
+
+## Roadmap
+
+See the various [issues](https://github.com/wingrunr21/mindbody-api/issues?state=open)
+
+## Credits
+
+This gem is written by [Stafford Brunk](https://github.com/wingrunr21)
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/wingrunr21/mindbody-api/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+require 'dotenv/tasks'
+
+# Rake tasks from https://github.com/mojombo/rakegem/blob/master/Rakefile
+
+# Helper Functions
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+# Standard tasks
+RSpec::Core::RakeTask.new(:spec)
+task :test => :spec
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console => :dotenv do
+  sh "pry -Ilib -r #{name}.rb"
+end
+
+namespace :wsdl do
+  desc "Update the cached MindBody API wsdls"
+  task :update do
+    require 'open-uri'
+
+    url = "https://api.mindbodyonline.com/0_5/%sService.asmx?wsdl"
+    services = %w{Appointment Class Client Finder Sale Site Staff}
+
+    services.each do |service|
+      wsdl = open(url % service).read
+      File.open("wsdl/#{service}Service.wsdl", 'w') do |f|
+        f.write wsdl
+      end
+    end
+  end
+end

data/lib/mindbody-api.rb

@@ -0,0 +1,35 @@
+require 'active_support/inflector'
+require 'active_support/core_ext/array/extract_options'
+
+require 'mindbody-api/version'
+require 'mindbody-api/models'
+require 'mindbody-api/service'
+require 'mindbody-api/api_status'
+
+module MindBody
+  class << self
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration ||= Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :log_level, :open_timeout, :read_timeout, :source_name, :source_key, :site_ids
+
+    def initialize
+      @log_level = :debug
+      @source_name = ENV['MINDBODY_SOURCE_NAME'] || ''
+      @source_key = ENV['MINDBODY_SOURCE_KEY'] || ''
+      @site_ids = (ENV['MINDBODY_SITE_IDS'] || '').scan(/-?\d+/).map(&:to_i)
+    end
+
+    # Make sure site_ids is always an Array
+    def site_ids=(ids)
+      @site_ids = [*ids]
+    end
+  end
+end

data/lib/mindbody-api/api_status.rb

@@ -0,0 +1,109 @@
+module MindBody
+  module APIStatus
+    class Base
+      attr_accessor :message
+
+      def initialize(message = '')
+        @message = message
+      end
+
+      def self.status
+        :undefined_error
+      end
+
+      def status
+        self.class.status
+      end
+
+      def self.error_code
+        9999
+      end
+
+      def error_code
+        self.class.error_code
+      end
+    end
+
+    def self.build_status(code, status, message = nil)
+      # Double underscores makes sure Foo Bar and FooBar get
+      # the same treatment
+      underscore_status = status.underscore.parameterize.underscore
+      klass_name = underscore_status.camelize
+      
+      klass = if const_defined?(klass_name)
+        const_get(klass_name)
+      else
+        define_api_status_constant(klass_name, underscore_status, code)
+      end
+
+      klass.new(message)
+    end
+
+    def self.define_api_status_constant(name, status, code)
+      klass = const_set(name, Class.new(Base))
+      klass.send(:define_singleton_method, :status) {status.to_sym}
+      klass.send(:define_singleton_method, :error_code) {code}
+      klass
+    end
+
+    # MindBody API code defintions
+    # Commented out codes have not been verified via the API.
+    # MindBody's own code definitions are not accurate and
+    # they are not willing to provide the correct mappings
+    # publically at this time
+    STATUS_CODES = {
+      #101 => "Invalid Source Credentials",
+      102 => "InvalidCredentials",
+      #103 => "Invalid Staff Credentials",
+      #104 => "Invalid User Credentials",
+      200 => "Success",
+      #201 => "Something failed in your call",
+      #301 => "Client ID doesn't exist",
+      #302 => "Invalid SQL Format",
+      #303 => "Client Index doesn't exist",
+      #304 => "Client Index Value doesn't exist",
+      #305 => "Missing Required Client Fields",
+      #306 => "Invalid Class ID",
+      #308 => "Related Client ID doesn't exist",
+      #309 => "Client Custom Field doesn't exist",
+      #310 => "Client Custom Field Value has an incorrect data type",
+      #311 => "Rep ID doesn't exist",
+      #312 => "Staff ID doesn't exist",
+      #313 => "Missing required fields",
+      #314 => "Session/Appointment Type ID doesn't exist",
+      315 => "InvalidParameters",
+      #316 => "Appointment ID doesn't exist",
+      #317 => "Availabiliy ID doesn't exist",
+      #318 => "Invalid Payment Info",
+      #319 => "Staff not available",
+      #320 => "Client Service ID not found",
+      #321 => "Class Schedule ID doesn't exist",
+      #322 => "ContactLog Creation/Update Error",
+      #323 => "Unable to find client or found duplicate",
+      #324 => "Add/Update Staff error",
+      #501 => "Scheduling restrictions failed",
+      #502 => "Client is suspended from booking",
+      #503 => "Client needs payment",
+      #504 => "Client already booked",
+      #600 => "Class full",
+      #601 => "Class requires payment",
+      #602 => "Class is outside of scheduling window",
+      #603 => "Client already booked at this time",
+      #604 => "Client doesn't meet the prerequisites",
+      #605 => "Class capacity exceeded exception",
+      #606 => "Client already on waitlist",
+      #607 => "Waitlist full exception",
+      #700 => "Invalid booking time",
+      #800 => "Permission Exception",
+      #801 => "Staff member may not receive tips",
+      #900 => "RetailObject Exception",
+      #901 => "RetailItemNotFound Exception",
+      #1000 => "Location ID doesn't exist",
+      #1001 => "Setting Not Enabled on site",
+      #1002 => "PromotionCode Exception",
+      #1003 => "Resource Exception",
+      #2000 => "Finder user does not exist",
+      #2001 => "Finder user already exists"
+    }
+  end
+end

data/lib/mindbody-api/client.rb

@@ -0,0 +1,39 @@
+require 'mindbody-api/response'
+
+module MindBody
+  module Services
+    class Client < Savon::Client
+
+      def call(operation_name, locals = {}, &block)
+        # Inject the auth params into the request and setup the
+        # correct request structure
+        @globals.open_timeout(MindBody.configuration.open_timeout)
+        @globals.read_timeout(MindBody.configuration.read_timeout)
+        @globals.log_level(MindBody.configuration.log_level)
+        locals = locals.has_key?(:message) ? locals[:message] : locals
+        locals = fixup_locals(locals)
+        params = {:message => {'Request' => auth_params.merge(locals)}}
+
+        # Run the request
+        response = super(operation_name, params, &block)
+        Response.new(response)
+      end
+
+      private
+      def auth_params
+        {'SourceCredentials'=>{'SourceName'=>MindBody.configuration.source_name,
+                               'Password'=>MindBody.configuration.source_key,
+                               'SiteIDs'=>{'int'=>MindBody.configuration.site_ids}}}
+      end
+
+      def fixup_locals(locals)
+        # TODO this needs fixed to support various list types
+        locals.each_pair do |key, value|
+          if value.is_a? Array
+            locals[key] = {'int' => value}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindbody-api/ext/savon_ext.rb

@@ -0,0 +1,53 @@
+module MindBody
+  module SavonExt
+    module Service
+      private
+      # Defines a class-level SOAP operation.
+      def define_class_operation(operation, *options)
+        options = options.extract_options!
+        params = prepare_params(options)
+
+        class_operation_module.module_eval <<-RUBY_EVAL, __FILE__, __LINE__+1
+          def #{operation.to_s.snakecase}(#{params.join(',')})
+            req_hash = {
+              #{params.select{|p| p != 'locals = {}'}
+                      .map{|p| "'#{params_key(p)}' => #{p}"}
+                      .join(',')}
+            }
+            locals ||= {}
+            client.call #{operation.inspect}, :message => locals.merge(req_hash)
+          end
+        RUBY_EVAL
+      end
+
+      # Defines an instance-level SOAP operation.
+      # Defers to the class-level operation
+      def define_instance_operation(operation, *options)
+        options = options.extract_options!
+        params = prepare_params(options)
+
+        instance_operation_module.module_eval <<-RUBY_EVAL, __FILE__, __LINE__+1
+          def #{operation.to_s.snakecase}(#{params.join(',')})
+            self.class.#{operation.to_s.snakecase} #{params.join(',').chomp(' = {}')}
+          end
+        RUBY_EVAL
+      end
+
+      # Builds the array of params the
+      # generated method will utilize
+      def prepare_params(options)
+        params = options[:required] || []
+        params = params.map {|p| p.to_s.snakecase}
+        params.push 'locals = {}' if options[:locals].nil? || options[:locals]
+        params
+      end
+
+      # Maps the snakecase key to the
+      # correct MindBody upper case
+      def params_key(k)
+        key = k.to_s.camelize
+        key.gsub('Id', 'ID')
+      end
+    end
+  end
+end