mindbody-api 1.0.1.alpha

data/lib/mindbody-api/models/unavailability.rb

@@ -0,0 +1,7 @@
+module MindBody
+  module Models
+    class Unavailability < Availability
+      attribute :description, String
+    end
+  end
+end

data/lib/mindbody-api/models/visit.rb

@@ -0,0 +1,19 @@
+module MindBody
+  module Models
+    class Visit < Base
+      attribute :id, Integer
+      attribute :class_id, Integer
+      attribute :start_date_time, DateTime
+      attribute :end_date_time, DateTime
+      attribute :name, String
+      attribute :staff, Staff
+      attribute :location, Location
+      attribute :client, Client
+      attribute :web_signup, Boolean
+      attribute :signed_in, Boolean
+      attribute :make_up, Boolean
+      attribute :service, ClientService
+    end
+  end
+end
+

data/lib/mindbody-api/response.rb

@@ -0,0 +1,119 @@
+module MindBody
+  module Services
+    class Response
+      attr_reader :response, :result, :status, :error_code, :xml_detail,
+                  :result_count, :current_page_index, :total_page_count,
+                  :remote_method, :message, :api_status
+
+      def initialize(res)
+        @response = res
+        @result = {}
+        normalize_response
+        @api_status = APIStatus.build_status(error_code, status, message)
+      end
+
+      # Delegate methods to the @response object
+      def method_missing(method, *args, &blk)
+        if @response.respond_to?(method)
+          self.class.send(:define_method, method) do |*args, &blk|
+            @response.send(method, *args, &blk)
+          end
+          self.send(method)
+        else
+          super
+        end
+      end
+
+      def respond_to?(method, include_private = false)
+        super || @response.respond_to?(method)
+      end
+
+      private
+      def normalize_response
+        # All responses come back nested in a CallingMethodResponse
+        # and then a CallingMethodResult. Strip these two parents
+        # so we can get at the meat of the result. This is a naive
+        # strip
+        result = @response.to_hash
+        result = result.flatten.last.flatten[1]
+
+        result = normalize_hash(result)
+
+        # Loop over result. If we respond to a key of the response, consume it,
+        # otherwise build the result hash
+        @result.clear
+        result.each_pair do |key, value|
+          if self.respond_to?(key) && key != :class
+            self.instance_variable_set("@#{key}", value)
+          else
+            @result[key] = constantize_key(key, value)
+          end
+        end
+      end
+
+      # Recursively iterate over the hash and perform
+      # a number of optimizations:
+      #
+      #   * Sometimes data comes back like this:
+      #     things => {
+      #       thing => [thing1, thing2, thing3]
+      #     }
+      #
+      #     Map this pattern to be like this:
+      #     things => [thing1, thing2, thing3, ...
+      def normalize_hash(hash)
+        hash.each_pair do |key, value|
+          if value.is_a? Hash
+            hash[key] = normalize_hash(value)
+
+            key_singular = map_key(key).singularize.to_sym
+
+            if value.has_key?(key_singular)
+              hash[key] = value[key_singular]
+            elsif value.has_key?(:string)
+              hash[key] = value[:string]
+            elsif value.has_key?(:int)
+              hash[key] = value[:int]
+            end
+          elsif value.is_a? Array
+            value.map! do |i|
+              i.is_a?(Hash) ? normalize_hash(i) : i
+            end
+          end
+        end
+
+        return hash
+      end
+
+      def constantize_key(key, value)
+        begin
+          klass_s = map_key(key).classify
+          klass = "MindBody::Models::#{klass_s}".constantize
+
+          # Make sure we return a properly mapped array if needed
+          value.is_a?(Array) ? value.map {|v| klass.new(v)} : klass.new(value) unless value.nil?
+        rescue
+          value
+        end
+      end
+
+      # We have some keys that need
+      # to be mapped to others so that classify works properly.
+      #
+      # We cannot use inflector to do this because some words are popular
+      # enough to stomp on people's namespaces
+      def map_key(key)
+        case key
+        when :staff_members, :organizer
+          'staff'
+        when :purchases
+          'sale_item'
+        when :image_url, :mobile_image_url
+          'string'
+        else
+          key.to_s
+        end
+      end
+    end
+  end
+end

data/lib/mindbody-api/service.rb

@@ -0,0 +1,39 @@
+require 'savon'
+require 'mindbody-api/client'
+require 'mindbody-api/ext/savon_ext'
+
+module MindBody
+  module Services
+    class Service
+      extend Savon::Model
+
+      WSDL_PATH = File.expand_path(File.join(__FILE__, '..', '..', '..', 'wsdl', '%s.wsdl'))
+
+      class << self
+        def service(name)
+          @wsdl = WSDL_PATH % name.to_s
+          client :wsdl => @wsdl
+        end
+
+        def client(globals = {})
+          @client ||= Client.new(globals)
+        end
+
+        def operation(name, *opts)
+          define_class_operation(name, *opts)
+          define_instance_operation(name, *opts)
+        end
+
+        include MindBody::SavonExt::Service
+      end
+    end
+  end
+end
+
+require 'mindbody-api/services/appointment_service'
+require 'mindbody-api/services/class_service'
+require 'mindbody-api/services/client_service'
+require 'mindbody-api/services/finder_service'
+require 'mindbody-api/services/sale_service'
+require 'mindbody-api/services/site_service'
+require 'mindbody-api/services/staff_service'

data/lib/mindbody-api/services/appointment_service.rb

@@ -0,0 +1,15 @@
+module MindBody
+  module Services
+    class AppointmentService < Service
+      service "AppointmentService"
+
+      operation :get_staff_appointments,       :required => [:staff_credentials]
+      operation :get_bookable_items,           :required => [:session_type_ids]
+      operation :get_schedule_items
+      operation :add_or_update_appointments,   :required => [:appointments]
+      operation :add_or_update_availabilities, :required => [:user_credentials]
+      operation :get_active_session_times
+      operation :get_appointment_options
+    end
+  end
+end

data/lib/mindbody-api/services/class_service.rb

@@ -0,0 +1,12 @@
+module MindBody
+  module Services
+    class ClassService < Service
+      service "ClassService"
+
+      operation :get_classes
+      operation :get_class_visits,           required:[:class_id]
+      operation :get_class_descriptions
+      operation :get_class_schedules
+    end
+  end
+end

data/lib/mindbody-api/services/client_service.rb

@@ -0,0 +1,30 @@
+module MindBody
+  module Services
+    class ClientService < Service
+      service 'ClientService'
+
+      operation :add_arrival,                    :required => [:client_id, :location_id],                                   :locals => false
+      operation :add_or_update_clients,          :required => [:clients]
+      operation :get_clients
+      operation :get_custom_client_fields,                                                                                  :locals => false
+      operation :get_client_indexes,                                                                                        :locals => false
+      operation :get_client_contact_logs,        :required => [:client_id]
+      operation :add_or_update_contact_logs,     :required => [:contact_logs]
+      operation :get_contact_log_types,                                                                                     :locals => false
+      operation :upload_client_document,         :required => [:client_id, :filename, :bytes]
+      operation :get_client_referral_types,                                                                                 :locals => false
+      operation :get_active_client_memberships,  :required => [:client_id]
+      operation :get_client_contracts,           :required => [:client_id]
+      operation :get_client_account_balances,    :required => [:client_ids]
+      operation :get_client_services,            :required => [:client_id]
+      operation :get_client_visits,              :required => [:client_id]
+      operation :get_client_purchases,           :required => [:client_id]
+      operation :get_client_schedule,            :required => [:client_id]
+      operation :get_required_client_fields,                                                                                :locals => false
+      operation :validate_login,                 :required => [:username, :password],                                       :locals => false
+      operation :update_client_services,         :required => [:client_services]
+      operation :send_user_new_password,         :required => [:user_email, :user_first_name, :user_last_name],             :locals => false
+    end
+  end
+end
+

data/lib/mindbody-api/services/finder_service.rb

@@ -0,0 +1,11 @@
+module MindBody
+  module Services
+    class FinderService < Service
+      service 'FinderService'
+
+      operation :get_classes_within_radius,            :required => [:search_latitude, :search_longitude, :search_radius]
+      operation :get_session_types_within_radius,      :required => [:search_latitude, :search_longitude, :search_radius]
+      operation :get_business_locations_within_radius, :required => [:search_latitude, :search_longitude, :search_radius]
+    end
+  end
+end

data/lib/mindbody-api/services/sale_service.rb

@@ -0,0 +1,14 @@
+module MindBody
+  module Services
+    class SaleService < Service
+      service "SaleService"
+
+      operation :get_accepted_card_type,      :locals => false
+      operation :get_sales
+      operation :get_services
+      operation :get_packages
+      operation :get_products
+      operation :get_custom_payment_methods
+    end
+  end
+end

data/lib/mindbody-api/services/site_service.rb

@@ -0,0 +1,15 @@
+module MindBody
+  module Services
+    class SiteService < Service
+      service 'SiteService'
+
+      operation :get_sites
+      operation :get_locations,           :locals => false
+      operation :get_activation_code,     :locals => false
+      operation :get_programs
+      operation :get_session_types
+      operation :get_resources
+      operation :get_relationships,       :locals => false
+    end
+  end
+end

data/lib/mindbody-api/services/staff_service.rb

@@ -0,0 +1,12 @@
+module MindBody
+  module Services
+    class StaffService < Service
+      service 'StaffService'
+
+      operation :get_staff
+      operation :get_staff_permissions
+      operation :add_or_update_staff,     :required => [:staff]
+      operation :get_staff_img_url,       :required => [:staffid]
+    end
+  end
+end

data/lib/mindbody-api/version.rb

@@ -0,0 +1,4 @@
+module MindBody
+  VERSION = "1.0.1.alpha"
+  API_VERSION = "0.5.2.0"
+end

data/mindbody-api.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mindbody-api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mindbody-api"
+  gem.version       = MindBody::VERSION
+  gem.authors       = ["Stafford Brunk"]
+  gem.email         = ["stafford.brunk@gmail.com"]
+  gem.description   = %q{A Ruby interface for the MindBody API}
+  gem.summary       = %q{This gem provides a Ruby interface for the MindBody API in both a services format and a 'Rails-style' format}
+  gem.homepage      = "http://wingrunr21.github.io/mindbody-api/"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'savon', '~> 2.11.0'
+  gem.add_dependency 'virtus', '~> 1.0.0'
+  gem.add_dependency 'activesupport', '>= 3.2.11'
+
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
+  gem.add_development_dependency 'simplecov', '~> 0.8.2'
+  gem.add_development_dependency 'guard-rspec', '~> 4.2.8'
+  gem.add_development_dependency 'rake', '~> 10.0.3'
+end

data/spec/api_status_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe MindBody::APIStatus do
+  subject { MindBody::APIStatus }
+
+  describe '#build_status' do
+    before do
+      @preconstants = MindBody::APIStatus.constants
+    end
+    after do
+      (MindBody::APIStatus.constants - @preconstants).each do |const|
+        MindBody::APIStatus.send(:remove_const, const)
+      end
+    end
+
+    it 'should return a new instance of the given status' do
+      status = subject.build_status(102, 'InvalidCredentials')
+      expect(status.error_code).to eq(102)
+      expect(status.status).to eq :invalid_credentials
+      expect(status.class.to_s).to eq 'MindBody::APIStatus::InvalidCredentials'
+    end
+
+    it 'should normalize oddities in the given status' do
+      status = subject.build_status(315, 'invalid.parameters')
+      expect(status.status).to eq :invalid_parameters
+      expect(status.class.to_s).to eq 'MindBody::APIStatus::InvalidParameters'
+    end
+
+    context "when the status has already been defined" do
+      before do
+        MindBody::APIStatus.const_set('InvalidCredentials', MindBody::APIStatus::Base)
+      end
+
+      it 'should return the existing constant' do
+        expect(MindBody::APIStatus).to receive(:define_api_status_constant).never
+
+        subject.build_status(102, 'InvalidCredentials')
+      end
+
+      after do
+        MindBody::APIStatus.send(:remove_const, 'InvalidCredentials')
+      end
+    end
+
+    context "when a new status has been received" do
+      before do
+        MindBody::APIStatus.stub(:define_api_status_constant)
+                           .and_return(MindBody::APIStatus::Base)
+      end
+      it 'should create a new constant' do
+        expect(MindBody::APIStatus).to receive(:define_api_status_constant)
+          .with('InvalidCredentials', 'invalid_credentials', 102)
+
+        subject.build_status(102, 'InvalidCredentials')
+      end
+    end
+  end
+
+  describe '#define_api_status_constant' do
+    before :all do
+      @klass = MindBody::APIStatus.define_api_status_constant(
+        'InvalidCredentials', :invalid_credentials, 102)
+    end
+
+    after :all do
+      MindBody::APIStatus.send(:remove_const, 'InvalidCredentials')
+    end
+
+    it 'should create a new constant that is a subclass of Base' do
+      expect(@klass.superclass).to eq MindBody::APIStatus::Base
+    end
+
+    it 'should override status to return the given status' do
+      expect(@klass.status).to eq :invalid_credentials
+    end
+
+    it 'should override error_code to return the given code' do
+      expect(@klass.error_code).to eq 102
+    end
+  end
+end
+
+describe MindBody::APIStatus::Base do
+
+  it 'should have a status of :undefined_error' do
+    expect(subject.status).to eq :undefined_error
+  end
+
+  it 'should have a status of :undefined_error at the class level' do
+    expect(subject.class.status).to eq :undefined_error
+  end
+
+  it 'should delegate status up to the class level' do
+    expect(subject.class).to receive(:status) 
+    subject.status
+  end
+
+  it 'should have an error_code of 9999' do
+    expect(subject.error_code).to eq 9999
+  end
+
+  it 'should have a error_code of 9999 at the class level' do
+    expect(subject.class.error_code).to eq 9999
+  end
+
+  it 'should delegate status up to the class level' do
+    expect(subject.class).to receive(:error_code) 
+    subject.error_code
+  end
+end