utensils / barcoded Goto Github PK

Before we can ship the newest changes we need to update the demo to support the removal of code-128a, code-128b, and code-128c.

Documentation:

• JSON requests
• XML requests
• Healthcheck endpoint
• Supported encodings/symbologies
• Supported image formats

@jamesbrink is there any additional configuration necessary for us to host the container at the aforementioned domain? I imagine this will only be an issue when we begin to host multiple containers representing different APIs on the same box.

In addition to a product page explaining what it was we built and why, it would be fantastic to have a demo people could interact with.

• The user shall be able to select a subset of the available encoding/symbologies.
• The user shall be able to input a phrase to encode.
• The system shall display an error if the input phrase is not valid.
• The system shall display an SVG of the successful barcode.

There should be no commas.

one, two, three = *%i(post, options, get)
=> [:"post,", :"options,", :get]

Define a /ping endpoint to return 200 "pong" on success to facilitate availability monitoring via tools like Pingdom and NewRelic.

We can probably re-use a lot of the generated site for this including the template (Tactile).

It'd be great to build a simple product page that explain what Barcoded was and how it can be used.

In addition, we might want to put a blurb about this being a product of the Utensils Union.

We need an area to document not only the API endpoints but instructions for running the Docker container.

• API POST request (JSON/XML support)
• Availability/healthcheck endpoint
• Supported symbologies
  • Formal name — Code 128A (Code Set A)
  • Barcoded value — code128a
  • Example valid data
  • Sample barcode optional
• Supported image formats
• Document Docker usage

supp2 and supp5 are calling the same class?

https://github.com/UtensilsUnion/barcoded/blob/master/lib/barcode_factory.rb#L28

Are we missing some extra logic here?

It's almost time to ship 1.1.0 — Hooray!

• QR code support
• Code 128 Auto-detection and multi-subset support
• Support for image height/width
• Demo updates for QR codes
• Demo updates for Code 128 changes
• Documentation updates
• Tag Master @ v1.1.0
• Tag Docker container @ v1.1.0
• Publish release announcements

Our dependencies are not as green as they used to be.

@jamesbrink let me know the OS type and version you'd like and I'll get the droplet spun up.

Barby supports GS1-128 but it's usage is different than the other barcodes, we should evaluate how we want to handle this and other special cases.

It'd be great if we could allow people to support the height/width for their barcodes. Perhaps we could setup something like this as the request:

{
    "encoding": "...",
    "format": "...",
    "data": "...",
    "options": {
        "width": 500,
        "height": 500
    }
}

This might lend itself to accepting options for individual barcode types too.

GS1-128 Is broken, as it requires 3 parameters.

Reference
https://github.com/toretore/barby/blob/master/lib/barby/barcode/gs1_128.rb#L11

@jamesbrink can you add a section to the README about running the container?

Is it possible to show text bellow some codes?

@jamesbrink let's pull together a few examples of APIs that provide a description endpoint, look over them, and make a decision about whether or not this project warrants one.

There is a separate task (#16) to create the actual demo, this task is to integrate it with our project page.

The API currently returns a relative link but really it should be absolute, this change now will make it easier in the long run to modify the storage of our assets (eg. CDN).