recras 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c304fa9873e27a97cf05afcf7615653d2947a73d
+  data.tar.gz: fa2c66e1f46bf7d18f31b2325161fac8e639dcc3
+SHA512:
+  metadata.gz: b3feab0297d08798da8d17254b01bb88e9301359c54979c4ef460984d7577921920ce100000ddd25819e28427066c79a85a124c945d9e9cf5687827ae68c12da
+  data.tar.gz: d4f302f753d332450015081b3d97669685fbd7fa1f084861cd94905997aefa44fc6f7bf980cb9b7fad7da2fd737b22ac8a79b531359d0c50f508a2cc63b3309a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in recras.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Henk Meijer
+
+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,151 @@
+# Recras
+
+The Recras gem is a straight forward ruby binder for the Recras API V2. This gem covers a great portion of the native API functionality, but certainly not a 100%. Feel free to fork this project and make adjustments.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'recras'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install recras
+
+## Usage
+
+To request two barcodes from two different ticket kinds (4 barcodes in total), you can do the following:
+
+### Setup
+```ruby
+# Setup the Recras client with credentials
+@recras_client = Recras::Client.new(username: 'beheer', password: 'demo')
+
+# Check the credentials first
+@recras_client.valid? #returns true or false
+
+# Get details about current user
+@recras_client.me # => #<Recras::Person:0x007fca5492ddf0 @id=1, @name="Joe Sixpack, @address="Street 1", @postal_code="1234 AB", @city="Amsterdam", @country_code="", @company_id=1, @phone="", @email="test@example.org">
+
+```
+
+### Combinations
+The Recras system bundles different products together in 'combinations'. Their API uses the term 'arrangementen' for it.
+
+A combination has a number of fields. __Not all the fields present in the native API are implemented. Feel free to add those and issue a pull request.__
+
+- id
+- name
+- visible_online
+- number_of_people
+- allowed_to_pay_later
+- combination_items
+- contact_form_id
+- client (returns the client object that made the request)
+
+
+```ruby
+# List the clients combinations
+@recras_client.combinations # => returns an array of <Recras::Combination> objects
+
+# Find a single combination:
+@recras_client.combination(4) => <Recras::Combination:0x007fc617cd1948 @id=4 ...>
+```
+
+### CombinationItem
+Each combination has multiple combination_items. In the native API these are called 'arrangementregels'. When checking availability or making a reservation, you always have to enter both the combination **and** the individual combination_items+number_of_people.
+
+Attributes:
+- id
+- location_id
+- begins_at (ISO 8601 Date Time format)
+- ends_at (ISO 8601 Date Time format)
+- description
+- number_of_people 
+- product_id
+
+```ruby
+# You can find the combination_items only through a combination:
+@combination = @recras_client.combinations.last
+@combination_items = @combination.combination_items # => Array of <Recras::CombinationItem> objects
+```
+
+### Checking availability
+Checking the availability is always a two-steps process: 
+1. Check the available days for chosen combination
+2. Fetch the available times for chosen day
+
+The `@combination.available_days` method takes several arguments:
+
+```ruby
+available_days(items: [], number_of_people: nil, from_time: Date.today, until_time: (Time.now + 3600*24*7))
+```
+
+- `items:` array of hashes. Example: `[{combination_item_id: 2, number_of_people: 1}, {combination_item_id: 5, number_of_people: 4}]`
+- `number_of_people:` an integer greater than 0.
+- `from_time` Start of date range
+- `until_time` End of date range
+
+__Important:__ If you don't supply the `items` argument, you have to enter a `number_of_people`. This gem than makes the assumption that you want each item in this combination to be chosen the same amount of times.
+#### Checking available days
+```ruby
+@combination.available_days(number_of_people: 2) #=> ["2017-04-11", "2017-04-12", "2017-04-13", "2017-04-14", "2017-04-15", "2017-04-17", "2017-04-18"]
+
+```
+
+#### Checking available times
+```ruby
+@combination.available_times(number_of_people: 2, date: "2018-04-11") #=> ["2017-04-14T11:00:00+02:00", "2017-04-14T11:30:00+02:00", "2017-04-14T12:00:00+02:00", "2017-04-14T12:30:00+02:00", "2017-04-14T13:00:00+02:00", "2017-04-14T13:30:00+02:00"]
+
+```
+
+### ContactForm
+If you see the checkout page of any of Recras' clients, you'll notice that the consumer has to fill in a couple of fields in the last step before the booking. These fields are specific to the selected Combination (arrangement). To know which fields to show, how to label them and with which identifier to submit them, you use the `@combination.contact_form`. In it are `<Recras::ContactFormField>` objects.
+
+
+### Make a booking
+Making a booking is not much different from checking times: you need to know when the consumer wants to book and wich items+quantity. It looks like this:
+__Please note:__ in the example below, we assume that the consumer want to book 2 units of every CombinationItem in given combination.
+```ruby
+contact_form_details: {
+	"contact.naam"=>"", 
+    "contactpersoon.voornaam"=>"Voornaam", 
+    "contactpersoon.achternaam"=>"Achternaam", 
+    "contactpersoon.email1"=>"test@example.org", 
+    "contactpersoon.telefoon1"=>"", 
+    "contactpersoon.adres"=>"", 
+    "contactpersoon.postcode"=>"", 
+    "contactpersoon.plaats"=>"", 
+    "veel_tekst_0"=>""
+}
+
+@combination.book(number_of_people: 2, date: "2017-04-14T13:00:00+02:00", contact_form_details: contact_form_details) # => #<Recras::Booking:0x007f99bab94c30 @id=8994, @status="reservering", @message="Boeking gemaakt", @customer_id=8986>
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/henkm/wheretocard.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Credits and disclaimer
+
+This gem is made with love by the smart people at [Eskes Media B.V.](http://www.eskesmedia.nl) and [dagjewegtickets.nl](https://www.dagjewegtickets.nl) 
+Recras is not involved with this project and has no affiliation with Eskes Media B.V. No rights can be derrived from using this gem.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "recras"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/recras.rb

@@ -0,0 +1,116 @@
+# load external dependencies first
+require 'httparty'
+require 'time'
+
+# load own classes
+require "recras/version"
+require "recras/config"
+require "recras/recras_error"
+# require "recras/api" not needed anymore, is now in client.rb
+require "recras/client"
+require "recras/person"
+require "recras/combination"
+require "recras/combination_item"
+require "recras/contact_form"
+require "recras/contact_form_field"
+require "recras/booking"
+
+module Recras
+
+	API_VERSION = 2
+
+  # returns the version number
+  def self.version
+    VERSION
+  end 
+
+  # this method maps the recras API objects to 
+  # the names used by this gem
+  def self.object_mappings
+  	[["personeel", Person], ["arrangement", Combination], ["contactformulier", ContactForm], ["velden", ContactFormField], ["booking", Booking]]
+  end
+
+  def self.url
+    "https://demo.recras.nl"
+  end
+
+  # initialize a new Person from given JSON.
+  def new_from_json(json) 
+    params = {}
+
+    # set each attribute based on the mapping
+    self.attribute_mapping.each do |o,n| 
+      # if o is a string, parse it
+      if n.is_a?(String)
+        # check if data type is specified (using @@ symbol)
+        if n.include?("@@")
+          if n.split("@@").last.downcase == 'time'
+           data = Time.new(n.split("@@").first)
+           # puts data.inspect
+           # raise ERR
+          else
+            data = n.split("@@").first
+          end
+          params[n.split("@@").first] = data
+        else
+          params[n] = json[o.to_s]
+        end
+        
+      # else, o is a class. Call the 'parse_children' method on it
+      else
+        # puts "n is a #{n.class.name}"
+        # loop through all the children (for example: 'regels' on 'arrangementen')
+        if json[o]
+          children = []
+          for item in json[o]
+            children << n.new_from_json(item)
+          end
+          params[n.plural_name] = children
+        end
+      end
+    end
+    self.new(params)
+  end
+
+	def self.parse_json(json: nil, endpoint: nil, client: nil)
+    if json.is_a?(Hash) && json["error"]
+      if json["message"]
+        raise RecrasError.new(self), json["message"]
+      else
+        raise RecrasError.new(self), json["error"]["message"]
+      end
+    else
+      Recras.object_mappings.each do |key,klass|
+  	    if endpoint.match(key)
+          # puts "Making new #{klass.name} with data: #{json}"
+          obj = klass.new_from_json(json)
+          if client
+            obj.client = client
+          end
+  	      return obj
+  	    end
+  	  end
+      raise RecrasError.new(self), "Unknwon object '#{endpoint}'"
+    end
+  end
+
+  # communicates with the server and returns either:
+  # - an object (Person, Booking)
+  # - an error
+  # - a json object
+  def self.make_request(endpoint, body: {}, http_method: :get, client: nil)
+    url = "#{Recras.url}/api#{Recras::API_VERSION}/#{endpoint}"
+
+    auth = client ? {username: client.username, password: client.password} : nil
+
+    if http_method && http_method.to_s == 'post'
+      response = HTTParty.post(url, basic_auth: auth, body: body)
+    else
+      response = HTTParty.get(url, basic_auth: auth, body: body)
+    end
+    
+    json = response.parsed_response
+    return json
+  end
+
+end

data/lib/recras/api.rb

@@ -0,0 +1,9 @@
+module Recras
+  # this module handles the communication with the recras API
+  # it has no instance methods, only class methods.
+  class Api
+    def self.make_request(endpoint)
+      
+    end
+  end
+end

data/lib/recras/booking.rb

@@ -0,0 +1,39 @@
+module Recras
+  
+  # links to 'arrangement_regels' in the API
+  # http://recras.github.io/docs/endpoints/contactformulieren.html
+  class Booking
+    extend Recras
+    # @note The is a required parameter.
+
+    attr_accessor :id
+    attr_accessor :status
+    attr_accessor :message
+    attr_accessor :customer_id
+    attr_accessor :payment_url
+    
+    # Initializer to transform a +Hash+ into an Client object    
+    # @param [Hash] args
+    def initialize(args=nil)
+      required_args = []
+      return if args.nil?
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # translates the mapping between the Recras API
+    # and the terms used in this gem
+    def self.attribute_mapping
+      [
+        ["id", "id"],
+        ["status", "status"],
+        ["message", "message"], 
+        ["boeking_id", "id"], 
+        ["klant_id", "customer_id"], 
+        ["payment_url", "payment_url"]
+      ]
+    end
+
+  end
+end

data/lib/recras/client.rb

@@ -0,0 +1,71 @@
+module Recras
+
+  class Client
+    # @note The is a required parameter.
+    attr_accessor :username
+    # @return [String] Your Wheretocard password
+    attr_accessor :password
+
+
+    #
+    # Initializer to transform a +Hash+ into an Client object
+    #
+    # @param [Hash] args
+    def initialize(args=nil)
+      required_args = [:username, :password]
+      for arg in required_args
+        if args.nil? || args[arg].nil?
+          raise RecrasError.new(self), "Insufficient login credentials. Please provide @username, @password"
+        end
+      end
+
+      return if args.nil?
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # communicates with the server and returns either:
+    # - an object (Person, Booking)
+    # - an error
+    # - a json object
+    def make_request(endpoint, body: {}, http_method: :get)
+      Recras.make_request(endpoint, body: body, http_method: http_method, client: self)
+    end
+
+    # returns true if credentials are valid, false otherwise
+    def valid
+      begin
+        me
+        return true
+      rescue RecrasError
+        return false
+      end
+    end
+    alias_method :valid?, :valid
+
+    # returns a Me object
+    def me
+      json = make_request("personeel/me")
+      Recras.parse_json(json: json, endpoint: "personeel")
+    end
+
+    # find a specific combination
+    def combination(id)
+      json = make_request("arrangementen/#{id}")
+      return Recras.parse_json(json: json, endpoint: "arrangementen", client: self)
+    end
+
+
+    # returns an array of available combinations
+    def combinations
+      result = make_request("arrangementen")
+      a = []
+      for json in result
+        a << Recras.parse_json(json: json, endpoint: "arrangementen", client: self)
+      end
+      return a
+    end
+    
+  end
+end

data/lib/recras/combination.rb

@@ -0,0 +1,184 @@
+module Recras
+
+  # links to 'arrangementen' in the API
+  # http://recras.github.io/docs/endpoints/arrangementen.html
+  class Combination
+    extend Recras
+    # @note The is a required parameter.
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :visible_online
+    attr_accessor :number_of_people
+    attr_accessor :allowed_to_pay_later
+    attr_accessor :combination_items
+    attr_accessor :contact_form_id
+    attr_accessor :client
+    
+    # Initializer to transform a +Hash+ into an Combination object    
+    # @param [Hash] args
+    def initialize(args=nil)
+      required_args = []
+      for arg in required_args
+        if args.nil? || args[arg].nil?
+          raise RecrasError.new(self), "Insufficient login credentials. Please provide @username, @password"
+        end
+      end
+
+      return if args.nil?
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # find a combination
+    def self.find(id)
+      json = Recras.make_request("arrangementen/#{id}")
+      # puts json
+      return Recras.parse_json(json: json, endpoint: "arrangement")
+    end
+
+    # returns a Recras::ContactForm
+    def contact_form
+      json = client.make_request("contactformulieren/#{contact_form_id}")
+      cf = Recras.parse_json(json: json, endpoint: "contactformulier", client: client)
+    end
+
+
+
+    # returns a list of available days (in string format) for a given campaign
+    # exampel: combination.available_days(combination_items: [{combination_item_id: 1, number_of_people: 2}])
+    # If no combination_items are given, assume that you want each item to be booked. In that scenario, 
+    # also use the 'number_of_people' argument. E.g.: @combination.available_days(number_of_people: 2).
+    def available_days(items: [], number_of_people: nil, from_time: Date.today, until_time: (Time.now + 3600*24*7))
+      product_items = convert_items(items, number_of_people)
+
+      if product_items.any?
+        body_data = {
+            arrangement_id: id,
+            producten: product_items,
+            begin: from_time.strftime("%Y-%m-%d"),
+            eind: until_time.strftime("%Y-%m-%d")
+        }
+
+        # make request
+        json = client.make_request("onlineboeking/beschikbaredagen", body: body_data.to_json, http_method: :post)
+
+        if json.is_a?(Hash) && json["error"]
+          raise RecrasError.new(self), json["error"]["message"]
+        else
+          return json
+        end
+      else
+        raise RecrasError.new(self), "Insufficient details provided. Either combination_items or number_of_people are required."
+      end
+    end
+
+
+    # returns a list of available days (in string format) for a given campaign
+    # exampel: combination.available_days(combination_items: [{combination_item_id: 1, number_of_people: 2}])
+    # If no combination_items are given, assume that you want each item to be booked. In that scenario, 
+    # also use the 'number_of_people' argument. E.g.: @combination.available_days(number_of_people: 2).
+    def available_times(items: [], number_of_people: nil, date: nil)
+      product_items = convert_items(items, number_of_people)
+
+      # convert date
+      date = convert_date(date)
+
+      if product_items.any?
+        body_data = { arrangement_id: id, producten: product_items, datum: date }
+        json = client.make_request("onlineboeking/beschikbaretijden", body: body_data.to_json, http_method: :post)
+
+        if json.is_a?(Hash) && json["error"]
+          raise RecrasError.new(self), json["error"]["message"]
+        else
+          return json
+        end
+      else
+        raise RecrasError.new(self), "Insufficient details provided. Either combination_items or number_of_people are required."
+      end
+    end
+
+
+    # make a reservation for this combination
+    def book(items: [], number_of_people: nil, date: nil, payment_method: "factuur", contact_form_details: {})
+
+      product_items = convert_items(items, number_of_people)
+      date = convert_date(date)
+
+      if product_items.any?
+        body_data = { 
+          arrangement_id: id, 
+          producten: product_items, 
+          begin: date,
+          betaalmethode: payment_method,
+          contactformulier: contact_form_details
+        }
+        json = client.make_request("onlineboeking/reserveer", body: body_data.to_json, http_method: :post)
+
+        if json.is_a?(Hash) && json["error"]
+          raise RecrasError.new(self), json["error"]["message"]
+        else
+          booking = Recras.parse_json(json: json, endpoint: "booking") 
+          return booking
+        end
+      else
+        raise RecrasError.new(self), "Insufficient details provided. Either combination_items or number_of_people are required."
+      end
+
+    end
+    alias_method :make_booking, :book
+
+    # returns an array of combination_items
+    # def combination_items
+    #   result = make_request("arrangementen")
+    #   a = []
+    #   for json in result
+    #     a << Recras.parse_json(json: json, endpoint: "arrangementen")
+    #   end
+    #   return a
+    # end
+
+    # translates the mapping between the Recras API
+    # and the terms used in this gem
+    def self.attribute_mapping
+      [["id", "id"],["weergavenaam", "name"],["mag_online", "visible_online"],["aantal_personen", "number_of_people"], ["mag_online_geboekt_worden_achteraf_betalen", "allowed_to_pay_later"], ["regels", Recras::CombinationItem], ["onlineboeking_contactformulier_id", "contact_form_id"]]
+    end
+
+    private
+
+    def convert_date(date)
+      if date.is_a?(Time)
+        return date.iso8601
+      elsif date.is_a?(String)
+        return Time.parse(date).iso8601
+      else
+        raise RecrasError.new(self), "Date is required and must be of type Time or String (ISO 8601)."
+      end
+    end
+
+    def convert_items(items, number_of_people)
+      if items.any?
+        # TODO
+      elsif number_of_people && number_of_people > 0
+        # assume that all the items will be chose the same amount
+        items = []
+        for combination_item in combination_items
+          items << {combination_item_id: combination_item.id, number_of_people: number_of_people}
+        end
+      end
+
+      if items && items.any?
+        mappings = {combination_item_id: "arrangementsregel_id", number_of_people: "aantal"}
+        product_items = []
+        for item in items
+          product_items << item.map {|k, v| [mappings[k], v] }.to_h
+        end
+        return product_items
+      end
+      
+      return items
+    end
+
+  end
+end

data/lib/recras/combination_item.rb

@@ -0,0 +1,38 @@
+module Recras
+  
+  # links to 'arrangement_regels' in the API
+  # http://recras.github.io/docs/endpoints/arrangementen.html
+  class CombinationItem
+    extend Recras
+    # @note The is a required parameter.
+
+    attr_accessor :id
+    attr_accessor :location_id
+    attr_accessor :begins_at
+    attr_accessor :ends_at
+    attr_accessor :description
+    attr_accessor :number_of_people
+    attr_accessor :product_id
+    
+    # Initializer to transform a +Hash+ into an Client object    
+    # @param [Hash] args
+    def initialize(args=nil)
+      required_args = []
+      return if args.nil?
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    def self.plural_name
+      "combination_items"
+    end
+
+    # translates the mapping between the Recras API
+    # and the terms used in this gem
+    def self.attribute_mapping
+      [["id", "id"],["locatie_id", "location_id"],["begin", "begins_at@@time"],["eind", "ends_at@@time"], ["beschrijving", "description"], ["aantal_personen", "number_of_people"], ["product_id", "product_id"]]
+    end
+
+  end
+end

data/lib/recras/config.rb

@@ -0,0 +1,8 @@
+#
+# Configuration object for storing some parameters required for making transactions
+#
+module Recras::Config
+  class << self
+    # config code here... (if needed)
+  end
+end

data/lib/recras/contact_form.rb

@@ -0,0 +1,56 @@
+module Recras
+  
+  # links to 'arrangement_regels' in the API
+  # http://recras.github.io/docs/endpoints/contactformulieren.html
+  class ContactForm
+    extend Recras
+    # @note The is a required parameter.
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :client
+    # attr_accessor :contact_form_fields
+    
+    # Initializer to transform a +Hash+ into an Client object    
+    # @param [Hash] args
+    def initialize(args=nil)
+      required_args = []
+      return if args.nil?
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    def self.plural_name
+      "contact_forms"
+    end
+
+    # returns an array of Recras::ContactFormField elements
+    def contact_form_fields
+      json = client.make_request("contactformulieren/#{id}/velden")
+      a = []
+      for element in json
+        a << Recras.parse_json(json: element, endpoint: "velden", client: client)
+      end
+      return a
+    end
+
+    # returns the minimum required attributes to make a valid
+    # booking. Only use this for testing purpose.
+    def default_values
+      a = {}
+      for field in contact_form_fields
+        a[field.field_identifier] = field.default_value
+      end
+      return a
+    end
+    
+
+    # translates the mapping between the Recras API
+    # and the terms used in this gem
+    def self.attribute_mapping
+      [["id", "id"],["name", "name"]]
+    end
+
+  end
+end

data/lib/recras/contact_form_field.rb

@@ -0,0 +1,64 @@
+module Recras
+  
+  # links to 'arrangement_regels' in the API
+  # http://recras.github.io/docs/endpoints/contactformulieren.html
+  class ContactFormField
+    extend Recras
+    # @note The is a required parameter.
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :contact_form_id
+    attr_accessor :input_type
+    attr_accessor :required
+    attr_accessor :options
+    attr_accessor :special_for_booking
+    attr_accessor :field_identifier
+    attr_accessor :contact_form
+    attr_accessor :client
+    
+    # Initializer to transform a +Hash+ into an Client object    
+    # @param [Hash] args
+    def initialize(args=nil)
+      required_args = []
+      return if args.nil?
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # translates the mapping between the Recras API
+    # and the terms used in this gem
+    def self.attribute_mapping
+      [
+        ["id", "id"],
+        ["naam", "name"],
+        ["contactformulier_id", "contact_form_id"], 
+        ["soort_invoer", "input_type"], 
+        ["verplicht", "required"], 
+        ["mogelijke_keuzes", "options"],
+        ["bijzonderheden_boeking", "special_for_booking"],
+        ["field_identifier", "field_identifier"]
+      ]
+    end
+
+    # returns default values for this field_identifier
+    def default_value
+      if field_identifier == "contactpersoon.email1"
+        return "test@example.org"
+      elsif field_identifier == "contactpersoon.naam"
+        return "Naamloos"
+      elsif field_identifier == "contactpersoon.voornaam"
+        return "Voornaam"
+      elsif field_identifier == "contactpersoon.achternaam"
+        return "Achternaam"
+      elsif field_identifier == "veel_tekst"
+        return "tekst"
+      else
+        # raise ERRR
+        return ""
+      end
+    end
+
+  end
+end

data/lib/recras/person.rb

@@ -0,0 +1,48 @@
+module Recras
+
+  class Person
+    extend Recras
+    # @note The is a required parameter.
+    attr_accessor :first_name
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :address
+    attr_accessor :postal_code
+    attr_accessor :city
+    attr_accessor :country_code
+    attr_accessor :region_code
+    attr_accessor :vat_number
+    attr_accessor :company_id
+    attr_accessor :bank_account_number
+    attr_accessor :first_name
+    attr_accessor :last_name
+    attr_accessor :phone
+    attr_accessor :email
+
+
+    #
+    # Initializer to transform a +Hash+ into an Client object
+    #
+    # @param [Hash] args
+    def initialize(args=nil)
+      required_args = []
+      for arg in required_args
+        if args.nil? || args[arg].nil?
+          raise RecrasError.new(self), "Insufficient login credentials. Please provide @username, @password"
+        end
+      end
+
+      return if args.nil?
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    # translates the mapping between the Recras API
+    # and the terms used in this gem
+    def self.attribute_mapping
+      [["id", "id"],["displaynaam", "name"],["adres", "address"],["postcode", "postal_code"], ["plaats", "city"], ["landcode", "country_code"],["bedrijf_id", "company_id"],["telefoon1","phone"],["email1", "email"]]
+    end
+
+  end
+end

data/lib/recras/recras_error.rb

@@ -0,0 +1,7 @@
+class RecrasError < StandardError
+  attr_reader :object
+  
+  def initialize(object)
+    @object = object
+  end
+end

data/lib/recras/version.rb

@@ -0,0 +1,3 @@
+module Recras
+  VERSION = "0.1.0"
+end

data/recras.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recras/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "recras"
+  spec.version       = Recras::VERSION
+  spec.authors       = ["Henk Meijer"]
+  spec.email         = ["henk.meijer@eskesmedia.nl"]
+
+  spec.summary       = %q{Ruby binder to the Recras API}
+  spec.description   = %q{Ruby binder to the Recras API}
+  spec.homepage      = "http://www.eskesmedia.nl/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "fakeweb"
+
+  spec.add_dependency 'httparty'
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: recras
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henk Meijer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: fakeweb
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby binder to the Recras API
+email:
+- henk.meijer@eskesmedia.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/recras.rb
+- lib/recras/api.rb
+- lib/recras/booking.rb
+- lib/recras/client.rb
+- lib/recras/combination.rb
+- lib/recras/combination_item.rb
+- lib/recras/config.rb
+- lib/recras/contact_form.rb
+- lib/recras/contact_form_field.rb
+- lib/recras/person.rb
+- lib/recras/recras_error.rb
+- lib/recras/version.rb
+- recras.gemspec
+homepage: http://www.eskesmedia.nl/
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby binder to the Recras API
+test_files: []