recras 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c304fa9873e27a97cf05afcf7615653d2947a73d
-  data.tar.gz: fa2c66e1f46bf7d18f31b2325161fac8e639dcc3
+  metadata.gz: 7064f4a5e12db70ed3a1ae6a97743b1109b8a7e9
+  data.tar.gz: e13b4e94d5b80eb0c7e46f59e9cc06d815b09ffa
 SHA512:
-  metadata.gz: b3feab0297d08798da8d17254b01bb88e9301359c54979c4ef460984d7577921920ce100000ddd25819e28427066c79a85a124c945d9e9cf5687827ae68c12da
-  data.tar.gz: d4f302f753d332450015081b3d97669685fbd7fa1f084861cd94905997aefa44fc6f7bf980cb9b7fad7da2fd737b22ac8a79b531359d0c50f508a2cc63b3309a
+  metadata.gz: 1bff5adb284a437064267f56e84b4cc44a0f4db43e5bf6ac28b670530561c98e10049505dc345752d00308450e89d9ddcd3f059d5d36da1234655a21454016e8
+  data.tar.gz: da3020ed4620cd4dbe5aead2c112ae7bc1d8c854a995faee1874c5e8cec0f1ac0f756acc8545bb5bc20920aa7790371ae2160abec69adc59a69601ae15c70b29

data/README.md

@@ -48,6 +48,7 @@ A combination has a number of fields. __Not all the fields present in the native
 - allowed_to_pay_later
 - combination_items
 - contact_form_id
+- itineraries (returns a list of `<Recras::Itinerary>` objects)
 - client (returns the client object that made the request)
 
 
@@ -56,7 +57,15 @@ A combination has a number of fields. __Not all the fields present in the native
 @recras_client.combinations # => returns an array of <Recras::Combination> objects
 
 # Find a single combination:
-@recras_client.combination(4) => <Recras::Combination:0x007fc617cd1948 @id=4 ...>
+@combination = @recras_client.combination(4) => <Recras::Combination:0x007fc617cd1948 @id=4 ...>
+
+# Show the itineraries
+for itinerary in @combination.itineraries
+	puts itenerary
+end
+# outputs:
+# Ontvangst met koffie - 10 personen (00:30:00)
+# Leer boogschieten - 10 personen (02:15:00)
 ```
 
 ### CombinationItem
@@ -109,6 +118,19 @@ __Important:__ If you don't supply the `items` argument, you have to enter a `nu
 ### 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.
 
+A ContactFormField has the following attributes:
+- id
+- name
+- contact_form_id
+- input_type
+- required
+- options
+- special_for_booking (if true, it will be displayed as information on the ticket/booking confirmation)
+- field_identifier
+- contact_form (parent object)
+
+
+
 
 ### 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:
@@ -126,7 +148,8 @@ contact_form_details: {
     "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>
+@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>
 ```
 
 

data/lib/recras.rb

@@ -14,6 +14,7 @@ require "recras/combination_item"
 require "recras/contact_form"
 require "recras/contact_form_field"
 require "recras/booking"
+require "recras/itinerary"
 
 module Recras
 
@@ -22,9 +23,9 @@ module Recras
   # returns the version number
   def self.version
     VERSION
-  end 
+  end
 
-  # this method maps the recras API objects to 
+  # 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]]
@@ -35,27 +36,35 @@ module Recras
   end
 
   # initialize a new Person from given JSON.
-  def new_from_json(json) 
+  def new_from_json(json)
     params = {}
 
     # set each attribute based on the mapping
-    self.attribute_mapping.each do |o,n| 
+    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
+          elsif n.split("@@").last.downcase == 'float'
+            data = n.split("@@").first.to_f
           else
             data = n.split("@@").first
           end
           params[n.split("@@").first] = data
         else
+          # puts "parsing value: #{n} => #{json[o]}"
           params[n] = json[o.to_s]
+          # puts "parsed value (#{params[n]})"
         end
-        
+
+      
+      # assign boolean value
+      elsif [FalseClass, TrueClass].include?(n.class)
+        # puts "Parsing boolean value: #{n} = #{json[o]}"
+        params[n] = json[o]
+        # puts "#{n} => #{o}"
       # else, o is a class. Call the 'parse_children' method on it
       else
         # puts "n is a #{n.class.name}"
@@ -68,7 +77,9 @@ module Recras
           params[n.plural_name] = children
         end
       end
+
     end
+    params['json'] = json
     self.new(params)
   end
 
@@ -99,7 +110,7 @@ module Recras
   # - an error
   # - a json object
   def self.make_request(endpoint, body: {}, http_method: :get, client: nil)
-    url = "#{Recras.url}/api#{Recras::API_VERSION}/#{endpoint}"
+    url = "#{client.host}/api#{Recras::API_VERSION}/#{endpoint}"
 
     auth = client ? {username: client.username, password: client.password} : nil
 
@@ -108,9 +119,9 @@ module Recras
     else
       response = HTTParty.get(url, basic_auth: auth, body: body)
     end
-    
+
     json = response.parsed_response
     return json
   end
 
-end
+end

data/lib/recras/client.rb

@@ -3,8 +3,9 @@ module Recras
   class Client
     # @note The is a required parameter.
     attr_accessor :username
-    # @return [String] Your Wheretocard password
+    # @return [String] Your Recras password
     attr_accessor :password
+    attr_accessor :host
 
 
     #
@@ -12,10 +13,10 @@ module Recras
     #
     # @param [Hash] args
     def initialize(args=nil)
-      required_args = [:username, :password]
+      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"
+          raise RecrasError.new(self), "Insufficient login credentials. Please provide @username, @password and @host"
         end
       end
 
@@ -66,6 +67,6 @@ module Recras
       end
       return a
     end
-    
+
   end
 end

data/lib/recras/combination.rb

@@ -8,14 +8,22 @@ module Recras
 
     attr_accessor :id
     attr_accessor :name
+    attr_accessor :welcome_location
     attr_accessor :visible_online
+    attr_accessor :max_number_of_people
     attr_accessor :number_of_people
     attr_accessor :allowed_to_pay_later
     attr_accessor :combination_items
+    attr_accessor :itineraries
+    attr_accessor :description
+    attr_accessor :price_per_person_incl_vat
+    attr_accessor :price_total_incl_vat
+    attr_accessor :seperate_planning
     attr_accessor :contact_form_id
     attr_accessor :client
-    
-    # Initializer to transform a +Hash+ into an Combination object    
+    attr_accessor :json
+
+    # Initializer to transform a +Hash+ into an Combination object
     # @param [Hash] args
     def initialize(args=nil)
       required_args = []
@@ -31,53 +39,62 @@ module Recras
       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)
+      return cf
     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, 
+    # example: 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?
+      if items && items.any?
+        begin
+          puts "starting product_items (#{items})"
+          product_items = convert_items(items, number_of_people)
+        rescue
+          # no items
+        end
+      end
+      if product_items && 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")
         }
+      elsif number_of_people
+        body_data = {
+            arrangement_id: id,
+            begin: from_time.strftime("%Y-%m-%d"),
+            eind: until_time.strftime("%Y-%m-%d")
+        }
+      else
+        raise RecrasError.new(self), "Insufficient details provided. Either combination_items or number_of_people are required."
+      end
+      # make request
+      json = client.make_request("onlineboeking/beschikbaredagen", body: body_data.to_json, http_method: :post)
 
-        # 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
+      if json.is_a?(Hash) && json["error"]
+        raise RecrasError.new(self), json["message"]
       else
-        raise RecrasError.new(self), "Insufficient details provided. Either combination_items or number_of_people are required."
+        return json
       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, 
+    # 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)
@@ -101,16 +118,17 @@ module Recras
 
 
     # make a reservation for this combination
-    def book(items: [], number_of_people: nil, date: nil, payment_method: "factuur", contact_form_details: {})
+    def book(items: [], number_of_people: nil, date: nil, payment_method: "factuur", status: "reservering", 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, 
+        body_data = {
+          arrangement_id: id,
+          producten: product_items,
           begin: date,
+          status: status,
           betaalmethode: payment_method,
           contactformulier: contact_form_details
         }
@@ -119,7 +137,7 @@ module Recras
         if json.is_a?(Hash) && json["error"]
           raise RecrasError.new(self), json["error"]["message"]
         else
-          booking = Recras.parse_json(json: json, endpoint: "booking") 
+          booking = Recras.parse_json(json: json, endpoint: "booking")
           return booking
         end
       else
@@ -142,7 +160,7 @@ module Recras
     # 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"]]
+      [["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], ["programma", Recras::Itinerary], ["onlineboeking_contactformulier_id", "contact_form_id"], ["prijs_pp_inc","price_per_person_incl_vat"], ["prijs_totaal_inc","price_total_incl_vat"],["los_op_planning", "seperate_planning"],["uitgebreide_omschrijving","description"], ["maximum_aantal_personen_online","max_number_of_people"], ["ontvangstlocatie", "welcome_location"]]
     end
 
     private
@@ -158,7 +176,7 @@ module Recras
     end
 
     def convert_items(items, number_of_people)
-      if items.any?
+      if items && items.any?
         # TODO
       elsif number_of_people && number_of_people > 0
         # assume that all the items will be chose the same amount
@@ -176,7 +194,7 @@ module Recras
         end
         return product_items
       end
-      
+
       return items
     end
 

data/lib/recras/combination_item.rb

@@ -10,9 +10,13 @@ module Recras
     attr_accessor :location_id
     attr_accessor :begins_at
     attr_accessor :ends_at
+    attr_accessor :name
     attr_accessor :description
     attr_accessor :number_of_people
     attr_accessor :product_id
+    attr_accessor :price
+    attr_accessor :minimum
+    attr_accessor :json
     
     # Initializer to transform a +Hash+ into an Client object    
     # @param [Hash] args
@@ -22,6 +26,7 @@ module Recras
       args.each do |k,v|
         instance_variable_set("@#{k}", v) unless v.nil?
       end
+      set_values_from_json
     end
 
     def self.plural_name
@@ -31,7 +36,15 @@ module Recras
     # 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"]]
+      [["id", "id"],["locatie_id", "location_id"],["begin", "begins_at@@time"],["eind", "ends_at@@time"], ["beschrijving", "description"], ["verkoop", "price@@float"], ["aantal_personen", "number_of_people"], ["product_id", "product_id"]]
+    end
+
+    private
+
+    def set_values_from_json
+      self.price = json["product"]["verkoop"].to_f
+      self.name = json["product"]["naam"]
+      self.minimum = json["product"]["minimum_aantal"].to_i
     end
 
   end

data/lib/recras/contact_form.rb

@@ -9,6 +9,7 @@ module Recras
     attr_accessor :id
     attr_accessor :name
     attr_accessor :client
+    attr_accessor :json
     # attr_accessor :contact_form_fields
     
     # Initializer to transform a +Hash+ into an Client object    

data/lib/recras/contact_form_field.rb

@@ -16,6 +16,7 @@ module Recras
     attr_accessor :field_identifier
     attr_accessor :contact_form
     attr_accessor :client
+    attr_accessor :json
     
     # Initializer to transform a +Hash+ into an Client object    
     # @param [Hash] args

data/lib/recras/itinerary.rb

@@ -0,0 +1,70 @@
+module Recras
+  
+  # links to 'programma' in the API
+  # http://recras.github.io/docs/endpoints/arrangementen.html
+  class Itinerary
+    extend Recras
+    # @note The is a required parameter.
+
+    attr_accessor :description
+    attr_accessor :quantity
+    attr_accessor :quantity_type
+    attr_accessor :start_time
+    attr_accessor :end_time
+    attr_accessor :duration
+    attr_accessor :json
+    
+    # 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
+
+    # outputs a nice readable itinerary
+    def to_s
+      "#{description} - #{quantity} #{quantity_type} (#{duration_string})"
+    end
+
+    def duration_string
+      "#{duration_hours.to_s.rjust(2, '0')}:#{duration_minutes.to_s.rjust(2, '0')}:#{duration_seconds.to_s.rjust(2, '0')}"
+    end
+
+    def duration_hours
+      begin
+        duration.split("PT").last.split("H").first.to_i
+      rescue
+        nil
+      end
+    end
+
+    def duration_minutes
+      begin
+        duration.split("H").last.split("M").first.to_i
+      rescue
+        nil
+      end
+    end
+
+    def duration_seconds
+      begin
+        duration.split("M").last.split("S").first.to_i
+      rescue
+        nil
+      end
+    end
+    def self.plural_name
+      "itineraries"
+    end
+
+    # translates the mapping between the Recras API
+    # and the terms used in this gem
+    def self.attribute_mapping
+      [["omschrijving", "description"], ["aantal", "quantity"], ["wat", "quantity_type"], ["begin", "start_time"], ["duur", "duration"], ["eind", "end_time"]]
+    end
+
+  end
+end

data/lib/recras/person.rb

@@ -18,6 +18,7 @@ module Recras
     attr_accessor :last_name
     attr_accessor :phone
     attr_accessor :email
+    attr_accessor :json
 
 
     #

data/lib/recras/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recras
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Henk Meijer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - lib/recras/config.rb
 - lib/recras/contact_form.rb
 - lib/recras/contact_form_field.rb
+- lib/recras/itinerary.rb
 - lib/recras/person.rb
 - lib/recras/recras_error.rb
 - lib/recras/version.rb